OpenAPI Specification
Portrait provides a REST API which is documented via an OpenAPI Specification.
To retrieve the spec of your instance call:
https://portrait.customer.xyz/v3/api-docs
This will return a JSON formatted OpenAPI Specification, which can be used for example to create a Request Collection in Postman or Insomnia
The OpenAPI Specification is not guarandteet to be stable throughout the different versions (Major, Minor and Hotfit).
Be sure to update the Specification in your Rest Client (postman, …) after you update Portrait!
API User Interface
In addition to the raw JSON OpenAPI specification, we also provide a practical UI to view and access the API in the browser.
To access the API documentation, open the following site:
https://portrait.customer.xyz/api-docs
In case the forwarding does not work try https://portrait.customer.xyz/swagger-ui/index.html
This should bring you to the following site:
Most API Calls require Authentification (see the lock on the right). To authenticate click “Authorize on the top right.
Here you have to provide your Portrait Login (email+password)
Afterward you should be able to call the API Methods via the try out button.
