LogoLogo
  • User related interactions
  • Data Endpoints Related interactions
  • NFCard related interactions
  • User Verification related interactions
  • Internal Platform Related Interactions
  • Database Entries
Powered by GitBook
LogoLogo

Copyright NFBoat 2023, All rights reserved.

On this page

NFCard related interactions

/register_nfcard

Values required : NFCard Hash, User Token

Returns the user basic data if the operation is successful

Example : https://outcrypt.nfboat.com/register_nfcard?
card_hash=a4e4c5783eb02d580c7519cd930de16b62ff51&
cookie=00000000

/add_document

Values required : User Token, Document IPFS Hash, Document Category, NFCard Hash

Returns the user basic data if the operation is successful

Example : https://outcrypt.nfboat.com/add_document?
document_hash=a4e4c5783eb02d580c7519cd930de16b62ff51&
cookie=00000000&
category=1&
nfcard_hash=a4e4c5783eb02d580c7519cd930de16b62ff51

/add_equipement

Values required : Equipement Name, Equipement Category, Expiry Date, Reminder Date, NFCard Hash, User Token

Returns a JSON of the user basic informations to acknowledge that the operation is successful.

Example : https://outcrypt.nfboat.com/add_equipement?
expiry_date=10/04/2023&
category=Masque&
cookie=2017073247&
nfcard_hash=QmUEbT9NEYqMcBkQP5bWgBpb6sewv66P1Kai1wMahAVFqB&
equipement_name=Masque%20de%20plong%C3%A9e&
reminder_date=01/05/2023

/remove_document

Values required : Document UUID, User Cookie

Returns a JSON of the user basic informations to acknowledge that the operation is successful.

Example : https://outcrypt.nfboat.com/remove_document?
uuid=b53a03fe-fd2d-4e2f-97ec-d4838e9d833d&
cookie=2017073247

/remove_nfcard

Values required : NFCard IPFS Hash, User Cookie

Returns a JSON of the user basic informations to acknowledge that the operation is successful.

Example : https://outcrypt.nfboat.com/remove_nfcard?
card_hash=a4e4c5783eb02d580c7519cd930de16b62ff51&
cookie=2017073247

/remove_equipement

Values required : Equipement UUID, User Cookie

Returns a JSON of the user basic informations to acknowledge that the operation is successful.

Example : https://outcrypt.nfboat.com/remove_equipement?
uuid=b53a03fe-fd2d-4e2f-97ec-d4838e9d833d&
cookie=2017073247

/get_nfcard

Values required : NFCard IPFS Hash, User Cookie

Returns a JSON of the NFCard informations

Example : https://outcrypt.nfboat.com/get_nfcard?
ipfsHash=QmezxdEN3SUw1TsnZefMAVFFYmPNBWkEA7dnEsNFFFpKHb
cookie=2017073247

/get_all_nfcards

Values required : User Cookie

Returns a JSON containing all of the user NFCards

Example : https://outcrypt.nfboat.com/get_all_nfcards?
cookie=2017073247

/get_documents_for_nfcard

Values required : User Cookie

Returns a JSON containing all of the documents related to the given NFCard hash

Example : https://outcrypt.nfboat.com/get_documents_for_nfcard?
cookie=154295412&
ipfsHash=QmUEbT9NEYqMcBkQP5bWgBpb6sewv66P1Kai1wMahAVFqC

/request_nfcard_transfer

Values required:

User Cookie, Receiving Email, NFCard Hash, Expiry epoch (timestamp)

A boolean indicating success or failure of the transfer request.

Example : https://outcrypt.nfboat.com/
request_nfcard_transfer?
cookie=2017073247&
receivingEmail=example@example.com&
nfcardHash=QmUEbT9NEYqMcBkQP5bWgBpb6sewv66P1Kai1wMahAVFqC&
timestamp=3600

/accept_nfcard_transfer

Values required:

Receiving Email, NFCard Hash, Receiving Cookie

A boolean indicating success or failure of the transfer acceptance.

Example:

https://outcrypt.nfboat.com/accept_nfcard_transfer?
receivingEmail=example@example.com&
nfcardHash=QmUEbT9NEYqMcBkQP5bWgBpb6sewv66P1Kai1wMahAVFqC&
receivingCookie=2017073247

/cancel_nfcard_transfer

Values required:

User Cookie, Receiving Email, NFCard Hash

A boolean indicating success or failure of the transfer cancellation.

Example:

https://outcrypt.nfboat.com/cancel_nfcard_transfer?
cookie=2017073247&
receivingEmail=example@example.com&
nfcardHash=QmUEbT9NEYqMcBkQP5bWgBpb6sewv66P1Kai1wMahAVFqC

/reject_nfcard_transfer

Values required:

Receiving Email, NFCard Hash, Receiving Cookie

A boolean indicating success or failure of the transfer rejection.

Example:

https://outcrypt.nfboat.com/reject_nfcard_transfer?
receivingEmail=example@example.com&
nfcardHash=QmUEbT9NEYqMcBkQP5bWgBpb6sewv66P1Kai1wMahAVFqC&
receivingCookie=2017073247
PreviousData Endpoints Related interactionsNextUser Verification related interactions

Last updated 1 year ago