Examples

Authenticate

Before making requests to the platform, you must use one of the following methods to authenticate.

Using an API key

If you have an API key, you can use it in every call by putting it in the URL or the headers of the requests. This is the preferred method for using the API.

API key in URL

curl --request GET \
     --url https://jmapcloud.io/api/mcs/rest/v1/organizations/organization/projects?apiKey=J9dh&skTjks9lks8K82Jhzod2J2j \
     --header 'Accept: application/json'

API key in headers

curl --request GET \
     --url https://jmapcloud.io/api/mcs/rest/v1/organizations/organization/projects \
     --header 'Accept: application/json'
     --header 'Api-Key: J9dh&skTjks9lks8K82Jhzod2J2j'

Using user credentials

If you want to use user credential to access the API, you must call the authenticate endpoint (https://jmapcloud.readme.io/reference/getaccesstoken) with the username and password. This will return the JWT token that you must add in the headers of every request.

/rest/v1/authenticate

Authenticate request

curl --request POST \
     --url https://jmapcloud.io/api/ss/rest/v1/authenticate \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '
{
     "username": "[email protected]",
     "password": "hG8w&I9Fjs3A92Kl"
}
'

Authenticate response

{
  "message": "The result is the access token",
  "result": "eyJhcGciOiJSUzI1NiIsInP5cCI6IkpXVCIsImtpZCI6I7pKMTRnTHZlQndub2xDWQ5lNHNRViJ9.eyJodHRwczovL2Rldi5qbWFwY2xvdWQuaW8vcm9sZXMiOlsiT1JHX0FETUlOIiwiT1JHX0VESVRPUiIsIk9SR19WSUVXRVIiLCJTWVNfQURNSU4iXSwiaHR0cHM6Ly9kZXYuam1hcGNsb3VkLmlvL2VtYWlsIjoiYWRtaW5AazJnZW9zcGF0aWFsLmNvbSIsImh0dHBzOi8vZGV2LmptYXBjbG91ZC5pby9uaWNrbmFtZSI6ImFkbWluIiwiaHR0cHM6Ly9kZXYuam1hcGNsb3VkLmlvL25hbWUiOiJTdXBlciBBZG1pbiBKTWFwIENsb3VkIiwiaHR0cHM6Ly9kZXYuam1hcGNsb3VkLmlvL3VzZXJfbWV0YWRhdGEiOnsicm9sZXMiOiJTWVNfQURNSU4sT1JHX0FETUlOLE9SR19FRElUT1IsT1JHX1ZJRVdFUiIsIm9yZ2FuaXphdGlvbklkIjoiNzg3Nzc2MDUtODA5Ny00Y2VjLTg1MmUtNzA5ZjEyNGU3Y2E5In0sImh0dHBzOi8vZGV2LmptYXBjbG91ZC5pby9vcmdhbml6YXRpb25zIjpbIjc4Nzc3NjA1LTgwOTctNGNlYy04NTJlLTcwOWYxMjRlN2NhOSJdLCJpc3MiOiJodHRwczovL2Rldi1rMi1nZW9zcGF0aWFsLnVzLmF1dGgwLmNvbS8iLCJzdWIiOiJhdXRoMHw2MmQwMTBhYzI0ZjMyYTQxODVjOTgxM2QiLCJhdWQiOiJodHRwczovL2Rldi5qbWFwY2xvdWQuaW8vIiwiaWF0IjoxNjU3ODExMDUzLCJleHAiOjE2NTc4OTc0NTMsImF6cCI6IkVUM1Z0azVEV25TclE4M2NzUllMV2dDUUxBd1NyMVVKIiwiZ3R5IjoicGFzc3dvcmQifQ.jaxn345sREs1SZQNZAMZt1yUTEUyGnvHVik4swbM5wekLHO3-RxID-AFXK8U_Pmo3DacXzoEYna8nvTlxBLy83S2c67PPI3qGOR1tBclYfbgL1dswLTJoigtDmozSv72MjwH6EKj7lZzxVzy8B73O8H72Nx7OmqlEOEQgRQukJuvjyvKa_ex7UyovwWdx_fl_6WbfTE9IXvsJkKYCiXlopXACyjeXDYPjMvAHItESxjVQWw-g6IERMLokvAKOKcb5C_aDO8Gh7mgpYgJnf95VfAvR4L7XUzFDr3_xv91D-YiStuZixrjQpB-ao68nsO_8SIcQofylKbGLJ0IOn1y9Q",
  "status": 200
}