authentic.network API documentation v2.4.0
Documentation for the REST api access of authentic.api
- ItemGroup
- Add Item
- Create Group
- Create Hook
- Delete Group
- Delete Hook
- Get Group
- Get Group Items
- Group Hooks
- Remove Item from Group
- Update Group
ItemGroup
Add Item
Add an item to a item group
POST /api/v2/groups/:idgroup/items/:iditem
Headers - Header
| Name | Type | Description |
|---|---|---|
| content-type | String |
Request content type, musst set to application/json |
| an-api-token | String |
API token |
Parameters - Parameter
| Name | Type | Description |
|---|---|---|
| idgroup | String |
The group id |
| iditem | String |
The item id |
Success response example
Success response example - Response:
HTTP/1.1 200 OK
Error response
Error response - Errors
| Name | Type | Description |
|---|---|---|
| 400 | Bad Request - The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, size too large, invalid request message framing, or deceptive request routing). |
|
| 403 | Forbidden - The request contained valid data and was understood by the server, but the server is refusing action. This may be due to the user not having the necessary permissions for a resource or needing an account of some sort, or attempting a prohibited action (e.g. creating a duplicate record where only one is allowed). This code is also typically used if the request provided authentication via the an-api-token header field, but the server did not accept that authentication. The request should not be repeated. |
|
| 404 | NotFound - The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible. |
|
| 409 | Conflict - Indicates that the request could not be processed because of conflict in the current state of the resource, such as an edit conflict between multiple simultaneous updates. |
|
| 500 | Internal server error - A generic error message, given when an unexpected condition was encountered and no more specific message is suitable. |
Create Group
Create a new item group.
POST /api/v2/groups
Headers - Header
| Name | Type | Description |
|---|---|---|
| content-type | String |
Request content type, musst set to application/json |
| an-api-token | String |
API token |
Parameters examples
json - Request-Example:
{
"image": "/images/identifiers/1000000000000000000000000/11877002.jpg",
"verificationinfos": [
{
"visible": "verified",
"label": "Manufacturer",
"value": "HelpPharma"
},
{
"value": [
"Robert-Koch-Str. 15",
"D-10623 Berlin"
],
"label": "Address",
"visible": "verified"
}
],
"title": "Test Item"
}
Success response example
Success response example - Success-Response:
{ "id": groupid, "data": { group data } }
Error response
Error response - Errors
| Name | Type | Description |
|---|---|---|
| 403 | Forbidden - The request contained valid data and was understood by the server, but the server is refusing action. This may be due to the user not having the necessary permissions for a resource or needing an account of some sort, or attempting a prohibited action (e.g. creating a duplicate record where only one is allowed). This code is also typically used if the request provided authentication via the an-api-token header field, but the server did not accept that authentication. The request should not be repeated. |
|
| 404 | NotFound - The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible. |
|
| 500 | Internal server error - A generic error message, given when an unexpected condition was encountered and no more specific message is suitable. |
Create Hook
Create hook for an item group.
POST /api/v2/groups/:id/hooks
Headers - Header
| Name | Type | Description |
|---|---|---|
| content-type | String |
Request content type, musst set to application/json |
| an-api-token | String |
API token |
Parameters - Parameter
| Name | Type | Description |
|---|---|---|
| id | String |
The group id |
Parameters examples
json - Request-Example:
{
"events": "itemScanned",
"url": "https://wh-echo.dev.authentic.network/webhook-endpoint",
"data": {
"key": "value"
}
}
Success response example
Success response example - Success-Response:
{ "id": hookid, "data": { hook data } }
Error response
Error response - Errors
| Name | Type | Description |
|---|---|---|
| 400 | Bad Request - The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, size too large, invalid request message framing, or deceptive request routing). |
|
| 403 | Forbidden - The request contained valid data and was understood by the server, but the server is refusing action. This may be due to the user not having the necessary permissions for a resource or needing an account of some sort, or attempting a prohibited action (e.g. creating a duplicate record where only one is allowed). This code is also typically used if the request provided authentication via the an-api-token header field, but the server did not accept that authentication. The request should not be repeated. |
|
| 404 | NotFound - The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible. |
|
| 500 | Internal server error - A generic error message, given when an unexpected condition was encountered and no more specific message is suitable. |
Delete Group
Delete a item group. Keep all existing items.
DELETE /api/v2/groups/:id
Headers - Header
| Name | Type | Description |
|---|---|---|
| content-type | String |
Request content type, musst set to application/json |
| an-api-token | String |
API token |
Parameters - Parameter
| Name | Type | Description |
|---|---|---|
| id | String |
The group id |
Success response example
Success response example - Response:
HTTP/1.1 200 OK
Error response
Error response - Errors
| Name | Type | Description |
|---|---|---|
| 403 | Forbidden - The request contained valid data and was understood by the server, but the server is refusing action. This may be due to the user not having the necessary permissions for a resource or needing an account of some sort, or attempting a prohibited action (e.g. creating a duplicate record where only one is allowed). This code is also typically used if the request provided authentication via the an-api-token header field, but the server did not accept that authentication. The request should not be repeated. |
|
| 404 | NotFound - The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible. |
|
| 500 | Internal server error - A generic error message, given when an unexpected condition was encountered and no more specific message is suitable. |
Delete Hook
Delete a hook from an item group.
GET /api/v2/groups/:id/hooks/:idwebhook
Headers - Header
| Name | Type | Description |
|---|---|---|
| content-type | String |
Request content type, musst set to application/json |
| an-api-token | String |
API token |
Parameters - Parameter
| Name | Type | Description |
|---|---|---|
| id | String |
The group id |
| idwebhook | String |
The hook id |
Success response example
Success response example - Response:
HTTP/1.1 200 OK
Error response
Error response - Errors
| Name | Type | Description |
|---|---|---|
| 403 | Forbidden - The request contained valid data and was understood by the server, but the server is refusing action. This may be due to the user not having the necessary permissions for a resource or needing an account of some sort, or attempting a prohibited action (e.g. creating a duplicate record where only one is allowed). This code is also typically used if the request provided authentication via the an-api-token header field, but the server did not accept that authentication. The request should not be repeated. |
|
| 404 | NotFound - The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible. |
|
| 500 | Internal server error - A generic error message, given when an unexpected condition was encountered and no more specific message is suitable. |
Get Group
Read an item group by group id.
GET /api/v2/groups/:id
Headers - Header
| Name | Type | Description |
|---|---|---|
| content-type | String |
Request content type, musst set to application/json |
| an-api-token | String |
API token |
Parameters - Parameter
| Name | Type | Description |
|---|---|---|
| id | String |
The group id |
Success response example
Success response example - Success-Response:
{ "id": groupid, "data": { group data } }
Error response
Error response - Errors
| Name | Type | Description |
|---|---|---|
| 403 | Forbidden - The request contained valid data and was understood by the server, but the server is refusing action. This may be due to the user not having the necessary permissions for a resource or needing an account of some sort, or attempting a prohibited action (e.g. creating a duplicate record where only one is allowed). This code is also typically used if the request provided authentication via the an-api-token header field, but the server did not accept that authentication. The request should not be repeated. |
|
| 404 | NotFound - The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible. |
|
| 500 | Internal server error - A generic error message, given when an unexpected condition was encountered and no more specific message is suitable. |
Get Group Items
Get list with items referenced by group. The items are returned sorted by _created in descending order. This allows the list to be queried page by page.
GET /api/v2/groups/:id/items
Headers - Header
| Name | Type | Description |
|---|---|---|
| content-type | String |
Request content type, musst set to application/json |
| an-api-token | String |
API token |
Parameters - Parameter
| Name | Type | Description |
|---|---|---|
| timestamp | Number |
Only items that creationdate are older than the specified timestamp. If not set, the result starts with the most recent. |
| limit | Number |
Number of expected entries |
| id | String |
The group id |
Success response example
Success response example - Success-Response:
{
"group": {
"id": "lQ9qZ9AsOaxmMqFXQfIW",
"data": {
"_created": 1594902309682,
"_updated": 1594902309682,
"data": {},
"_owner": "authentic-test"
}
},
"items": [
"953e5dcb45ce986b2e1fab347be96600d81b43c1",
"30a1dddc68eb6f01cf44c5eda4850f19dabcfd3a"
]
}
Success response example - Response:
HTTP/1.1 200 OK
Error response
Error response - Errors
| Name | Type | Description |
|---|---|---|
| 403 | Forbidden - The request contained valid data and was understood by the server, but the server is refusing action. This may be due to the user not having the necessary permissions for a resource or needing an account of some sort, or attempting a prohibited action (e.g. creating a duplicate record where only one is allowed). This code is also typically used if the request provided authentication via the an-api-token header field, but the server did not accept that authentication. The request should not be repeated. |
|
| 404 | NotFound - The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible. |
|
| 500 | Internal server error - A generic error message, given when an unexpected condition was encountered and no more specific message is suitable. |
Group Hooks
Get a list of exisiting hooks for a item group.
GET /api/v2/groups/:id/hooks
Headers - Header
| Name | Type | Description |
|---|---|---|
| content-type | String |
Request content type, musst set to application/json |
| an-api-token | String |
API token |
Parameters - Parameter
| Name | Type | Description |
|---|---|---|
| id | String |
The group id |
Success response example
Success response example - Success-Response:
{ "id": groupid, "type": "group", "hooks": [{ hook }] }
Error response
Error response - Errors
| Name | Type | Description |
|---|---|---|
| 403 | Forbidden - The request contained valid data and was understood by the server, but the server is refusing action. This may be due to the user not having the necessary permissions for a resource or needing an account of some sort, or attempting a prohibited action (e.g. creating a duplicate record where only one is allowed). This code is also typically used if the request provided authentication via the an-api-token header field, but the server did not accept that authentication. The request should not be repeated. |
|
| 404 | NotFound - The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible. |
|
| 500 | Internal server error - A generic error message, given when an unexpected condition was encountered and no more specific message is suitable. |
Remove Item from Group
Remove an item from a item group
DELETE /api/v2/groups/:idgroup/items/:iditem
Headers - Header
| Name | Type | Description |
|---|---|---|
| content-type | String |
Request content type, musst set to application/json |
| an-api-token | String |
API token |
Parameters - Parameter
| Name | Type | Description |
|---|---|---|
| idgroup | String |
The group id |
| iditem | String |
The item id |
Success response example
Success response example - Response:
HTTP/1.1 200 OK
Error response
Error response - Errors
| Name | Type | Description |
|---|---|---|
| 403 | Forbidden - The request contained valid data and was understood by the server, but the server is refusing action. This may be due to the user not having the necessary permissions for a resource or needing an account of some sort, or attempting a prohibited action (e.g. creating a duplicate record where only one is allowed). This code is also typically used if the request provided authentication via the an-api-token header field, but the server did not accept that authentication. The request should not be repeated. |
|
| 404 | NotFound - The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible. |
|
| 500 | Internal server error - A generic error message, given when an unexpected condition was encountered and no more specific message is suitable. |
Update Group
Update a existing item group
POST /api/v2/groups/:id
Headers - Header
| Name | Type | Description |
|---|---|---|
| content-type | String |
Request content type, musst set to application/json |
| an-api-token | String |
API token |
Parameters - Parameter
| Name | Type | Description |
|---|---|---|
| id | String |
The group id |
Success response example
Success response example - Success-Response:
{ "id": groupid, "data": { group data } }
Error response
Error response - Errors
| Name | Type | Description |
|---|---|---|
| 403 | Forbidden - The request contained valid data and was understood by the server, but the server is refusing action. This may be due to the user not having the necessary permissions for a resource or needing an account of some sort, or attempting a prohibited action (e.g. creating a duplicate record where only one is allowed). This code is also typically used if the request provided authentication via the an-api-token header field, but the server did not accept that authentication. The request should not be repeated. |
|
| 404 | NotFound - The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible. |
|
| 500 | Internal server error - A generic error message, given when an unexpected condition was encountered and no more specific message is suitable. |