Developer Portal
Background
Amboss has multiple GraphQL API endpoints that provides access to it’s different tools.
API Permissions
We have paid and free APIs. We do not allow commercial use of our free APIs.
If you want to use our free APIs for commercial purposes please reach out.
Apollo Studio
The Apollo Studio Explorer provides a listing of all queries and mutations available through the API. Results may be exported in CSV or JSON formats. Using the Explorer enables access to the API without requiring any coding experience.
The Apollo Explorer may be accessed here .
Accessing the API
Space and Magma
The Space and Magma API is available at https://api.amboss.space/graphql
A full listing of the queries and mutations available may be found here
Reflex
The Reflex API is available at https://reflex.amboss.tech/graphql
How to authenticate
For queries and mutations that need authentication you can get an API key by logging into amboss.space and going to your account panel.
In the API section you can create a new key.
The request should include the following header:
authorization: Bearer [API KEY]
Making Requests
cURL
curl -X POST -H "Content-Type: application/json" -d '{"query":"query{getHello}"}' https://api.amboss.space/graphql
Postman
To make a request from Postman you can follow these steps:
- Change request type to POST
- Change url to https://api.amboss.space/graphql
- Change body type to GraphQL
- Add your query as the Body
- Send the request
NodeJS Example
let options = {
'method': 'POST',
'url': ‘https://api.amboss.space/graphql',
'headers': {
'Authorization': 'Bearer [Amboss api key here]’,
'Content-Type': 'application/json'
},
body: JSON.stringify({
query: 'query Query {getHello}'
variables: VARIABLES_OBJECT
})
};
request(options, (error, response) => {
if (error) {
console.log(error)
}
else {
let json = JSON.parse(response.body);
console.log(json)
}
});