Technische documentatie voor integrators: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Thomas.sonck (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
= API | = Sidefish v5 API Documentation = | ||
== | == General == | ||
The Sidefish API is a RESTFUL JSON HTTP API that serves all server functions for creating, reading, updating and deleting Sidefish Platform data. | |||
Successful calls always return a HTTP status 200. | |||
Errors are returned with corresponding HTTP statuses, like 400, 403, 404 , etc. The response body contains an error description. | |||
== Endpoint == | |||
The Sidefish API is reachable at:<blockquote>[https://sidefish.app/api/v1/users https://sidefish.app/api/v1/] (PRODUCTION)</blockquote><blockquote>[https://sidefish.app/api/v1/users https://staging.sidefish.app/api/v1/users] (STAGING)</blockquote> | |||
== Authentication == | |||
== | === A. Bearer token === | ||
1. Request a JWT token via the login call. | |||
{| class="wikitable" | |||
|+ | |||
!Endpoint | |||
!Method | |||
!Request Body | |||
!Response Body | |||
|- | |||
|/login | |||
|POST | |||
|<syntaxhighlight lang="json"> | |||
{ | |||
email: string, | |||
password: string | |||
} | |||
</syntaxhighlight> | |||
|<syntaxhighlight lang="json"> | |||
{ | |||
token: string | |||
} | |||
</syntaxhighlight> | |||
|- | |||
|/logout | |||
|POST | |||
|<syntaxhighlight lang="json"> | |||
{} | |||
</syntaxhighlight> | |||
| | |||
|} | |||
2. Use the | |||
== Portfolios == | |||
== Customers == | |||
Revision as of 11:00, 27 October 2022
Sidefish v5 API Documentation
General
The Sidefish API is a RESTFUL JSON HTTP API that serves all server functions for creating, reading, updating and deleting Sidefish Platform data.
Successful calls always return a HTTP status 200.
Errors are returned with corresponding HTTP statuses, like 400, 403, 404 , etc. The response body contains an error description.
Endpoint
The Sidefish API is reachable at:
https://sidefish.app/api/v1/ (PRODUCTION)
Authentication
A. Bearer token
1. Request a JWT token via the login call.
| Endpoint | Method | Request Body | Response Body |
|---|---|---|---|
| /login | POST | {
email: string,
password: string
}
|
{
token: string
}
|
| /logout | POST | {}
|
2. Use the