...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
With the Nexus card ordering API, you can build in card ordering functions into your own application. This article provides an example instruction for a typical card ordering workflow.
For more information and real-time testing of the API, see Card ordering API 1.0.
Example: Place card order via the card ordering API
Log in to ordering portal
To send an order, or get information from the ordering portal, you first need to log in. If the login is successful, the result includes a bearer token to be used in other commands.
Log in with your supplied credentials to get a bearer token, using the method
POST /login.Expand title Example: Log in to ordering portal Code Block language text title Example: Log in POST /login { "username": "string" "password": "string" }Code Block language text title Example: Response { "result": "ok", "token": "string", "validUntil": "2020-02-11T12:57:35.301Z" }
Get layout options
If you want to see the options for layouts and accessories, follow these steps:
To view a list of available layouts for your company, use the method
GET /layout.Expand title Example: View available layouts Code Block language text title Example: View available layouts Authorization: Bearer <access token> GET /layoutCode Block language text title Example: Response { "foundCount": 0, "layouts": [ { "layoutId": 0, "layoutName": "string", "description": "string" } ] }To view layout fields for a specific layout, use the method
GET /layout{id}.Expand title Example: View layout fields Code Block language text title Example: View layout fields Authorization: Bearer <access token> GET /layout{id}Code Block language text title Example: Response { "layoutId": 0, "layoutName": "string", "articlesIncluded": [ { "artId": "CH3301-S", "name": "Card Holder EC Standard - Black", "description": "Card holder for one card with clip on back. The clip is easily removed and then holds two cards. One side is open for convenient card access", "imageUrl": "https://web.nexusonlineservices.com/Bilder/Artikel/1300.jpg" } ], "inputFields": [ { "name": "string", "label": "string", "type": "string", "required": true, "maxLength": 0, "valueList": [ { "index": "Accepted value for \"name\"", "label": "Explanation of index" } ] } ] }To view a list of available accessories, use the method
GET /accessories.Expand title Example: Get list of accessories Code Block language text title Example: Get list of accessories Authorization: Bearer <access token> GET /accessoriesCode Block language text title Example: Response { "artId": "CH3301-S", "name": "Card Holder EC Standard - Black", "description": "Card holder for one card with clip on back. The clip is easily removed and then holds two cards. One side is open for convenient card access", "imageUrl": "https://web.nexusonlineservices.com/Bilder/Artikel/1300.jpg" }
Send order
To post the order, including specification of layout fields and accessories, use the method
POST /order.Expand title Example: Send order Code Block language text title Example: Send order Authorization: Bearer <access token> POST /orderCode Block language text title Example: Response { "layoutId": 0, "inputField": "input value", "accessories": [ { "artId": "CH3301-S", "amount": 0 } ] }