Skip to content

Guide: Administration Rest API

Objective

This guide will introduce the Domain of the Administration Rest API to the reader. The guide will cover all the Contexts within the Domain, with a detailed explanation of every feature available and concrete business examples on how to use them. Also, code examples will be provided as a reference for technical profiles on how to integrate to the API. By the end of the guide, the reader should be able to understand and implement every flow described.

Introduction

The Administration Rest API is about administering the accounts and users with in the Operator platform. This means all operations specific for accounts and users will be responsibility of this API. More details of the features available within this API will be covered in the Content section. In Operator, everything happens around accounts and users. This guide is then the starting point of the Enreach API usage.

The Administration Rest API is integrated across the Enreach network to guarantee data consistency. This means, when an account is created, see here, will be immediately available for users to be created, but also for orders to be placed.

Content

In the domain of the Administration Rest API, the following Contexts are available:

Please visit every specific reference for a detailed explanation about what is available and how to use.

See the diagram below representing how the Contexts relate to each other.

erDiagram SUPPLIER }|..|{ ACCOUNT-GROUP : "owns 1..n" ACCOUNT-GROUP ||--o{ CUSTOMER : "1 is assigned to n" SUPPLIER }|--|| USER : "n belongs to 1" SUPPLIER ||--o{ CUSTOMER : creates SUPPLIER ||--|{ LOCATION : "contains 1..3" CUSTOMER ||--|{ LOCATION : "contains 1..3" CUSTOMER ||--|{ CONTACT : "contains 1..3" SUPPLIER ||--|{ CONTACT : "contains 1..3" USER ||--|{ CUSTOMER : "1 belongs to n"

Conclusions

This guide introduced the Domain of the Administration Rest API. The guide covered all the Contexts within the Domain, with a detailed explanation of every feature available and concrete business examples on how to use them. Also, code examples were provided as a reference for technical profiles on how to integrate to the API.

Happy usage of the Administration Rest API.