Breadcrumbs

Physical identifiers

Process prerequisites:

The token must be generated

URL base 

https://integration-360-api.nddprint.com/integration-360-api

Authorization

All endpoints must send the token in the request header.

Authorization: Bearer token

Authorization example:

Authorization: Bearer 089d22caa3f6d338239a14AuU09R3FZJWk4XhMHAAbXIkQw3oydFUF8VFlP0QkHI=

Card Codes

This endpoint returns the user's physical identifiers.

POST

JSON
api/v1/users/card-codes

Request Body: The following parameters must be included in the request body as JSON data.

  • LogonName (string)

  • DomainName (string)

Example of request:

JSON
POST api/v1/card-codes
Content-Type: application/json

{
  "LogonName": "usuario123",
  "DomainName": "dominio123"
}

Success response: If the request is successful, you will receive a response with the status 200 OK with the user's physical identifiers.

Example answer:

JSON
Status: 200 OK
Content-Type: application/json

{
    "uniqueCardCode": true,
    "cardCodes": [
        "123456789"
    ]
}

Error responses:

  • Status 400 Bad Request: The user was not found.

Add Card code

This endpoint adds the user's physical identifier.

POST

JSON
api/v1/users/add-card-code

Request Body: The following parameters must be included in the request body as JSON data.

  • LogonName (string)

  • DomainName (string)

  • ReplaceUniqueCardCode (boolean)

If the number of user card codes is set to Use only one card code per user:

True: If the user has a registered identifier, it will be replaced

False: Does not replace the physical identifier

  • CardCode (string)

Example of request:

JSON
POST api/v1/add-card-code
Content-Type: application/json

{
  "LogonName": "usuario123",
  "DomainName": "dominio123",
  "ReplaceUniqueCardCode": true,
  "CardCode": "ABC123456"
}

Success response: If the request is successful, you will receive a response with the status 200 OK with the updated identifier (if the ReplaceUniqueCardCode parameter was sent as true).

Example answer:

JSON
Status: 200 OK
Content-Type: application/json

true

Error responses:

  • Status 400 Bad Request: The request is missing the body or some required parameter.

  • Status 400 Bad Request: The user was not found.

  • Status 400 Bad Request: Code is being used by another user.