Upvest API

The purpose of this document is to describe the necessary steps to connect your application to our API.

We have a REST-like API and use JWT tokens as the authentication method. The tokens are issued by Auth0 which is an authentication-as-a-service service and serves as an authentication provider.

You can see an example application implementing Upvest API on https://github.com/upvest-cz/upvest-api-example

Send an email to petr.volny@upvest.cz with the following:

1. Name of your application
2. Type of your application (Regular web app / Single-page app / Native app / Machine-to-machine app) as per https://auth0.com/docs/applications
3. Allowed callback URL(s)
4. where your users will be redirected after authentication
5. Allowed logout URL(s)
6. where your users will be redirected after logging out
7. Allowed web origin URL(s)
8. which URLs will you be firing your requests from
9. used for CORS

We'll get back to you and provide you with the following:

1. Auth0 Client ID
2. Auth0 Client Secret (if required for your application type)
3. Auth0 domain

Now you have everything you need to start authenticating Upvest users in your application at your disposal. Head to https://auth0.com/docs/quickstarts/ to learn about how to wire up Auth0 with the application type of your choice.

Once you're done with setting up Auth0 with your application, you can proceed to making requests to the Upvest API. In order to create an authenticated request, make sure to send along the following cookies:

1. `id_token` with the Auth0 ID token
2. `access_token` with the Auth0 access token

Also, make sure that the following HTTP headers are in place:

1. `Accept: 'application/json'`
2. `Content-Type: 'application/json'`

Awesome! You're now ready to build an application on top of the Upvest API!