Create Account

1. Open Ecoroute Registration and follow the instructions.

Receive API Token

Execute the following command

$ curl --location 'https://api.ecoroute.io/token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "<YOUR_USERNAME>", 
    "password": "<YOUR_PASSWORD>",
    "audience": "https://api.ecoroute",
    "grant_type": "password"
}'

Get your user

Execute the following command

$ curl --location 'https://api.ecoroute.io/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <YOUR_API_TOKEN>' \
--data-raw '{
    "query":"query queryUser(first: Int!, offset: Int!) {\n    queryUser(first: $first, offset: $offset) {\n        id\n        email\n        tags {\n            id\n            name\n        }\n    }\n}",
    "variables": {"operationName": "queryUser", "first": 100, "offset": 0}
}'

Add your first Tag

Execute the following command

$ curl --location 'https://api.ecoroute.io/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <YOUR_API_TOKEN>' \
--data '{
    "query":"mutation($input: [AddTagInput!]!){\n  addTag(input: $input){\n    tag {\n      id\n      name\n      users {\n        id\n      }\n    }\n    numUids\n  }\n}",
    "variables":{
        "input":{
            "name":"<YOUR_TAG_NAME>",
            "users":[
                {
                    "id":"<YOUR_USER_ID>",
                    "email":"<YOUR_EMAIL>"
                }
            ],
            "createdAt":"2023-05-07T21:23:34.409Z"
        },
        "operationName": "addTag"
    }
}'

Add your first Search

Execute the following command

$ curl --location 'https://api.ecoroute.io/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <YOUR_API_TOKEN>' \
--data '{
    "query":"mutation($input: [AddSearchSetInput!]!){\n  addSearchSet(input: $input){\n    searchSet {\n     \tid\n      start\n      destination\n      tags {\n        id\n        name\n        users {\n          id\n        }\n      }\n      createdAt\n      state\n    }\n  }\n}",
    "variables":{
        "input": [
            {
                "start":"<YOUR_START>",
                "destination":"<YOUR_DESTINATION>",
                "tags":[
                    {
                        "id":"<YOUR_TAG_ID>"
                    }
                ],
                "active":true,
                "createdAt":"2023-05-07T20:31:02Z",
                "state":"NEW"
            }
        ],
        "operationName": "addSearchSet"
    }
}'

To guarantee the same quality of service for all our users, each request that uses our "/graphql"-endpoint and uses a "query*"-function (for example querySeaches, queryMatches, querySearchSet) has to contain 2 variables in it's payload.

The mentioned variables are marked as mandatory in our detailed api documentation (pay attention to the "!" next to variables)

If you are not familiar with the usage of "variables" we recommend reading the following source: https://graphql.org/

JSON-Schema

"variables": {
    "type": "object",
    "properties": {
        "first": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100
        },
        "offset": {
            "type": "integer",
            "minimum": 0
        }
    }
}

Example Payload

{"operationName": "queryTag","variables":{"first":10,"offset":0},"query":"query($filter: TagFilter!, $first: Int!, $offset: Int!) {\n    queryTag(filter: $filter, first: $first, offset: $offset) {\n        id\n        name\n        users {\n            id\n        }\n        searchSets {\n            searchesAggregate {\n                count\n            }\n            id\n            createdAt\n            state\n            start\n            destination\n            active\n            mergeSet {\n                id\n            }\n            searches {\n                id\n                distance\n                active\n                waypoints {\n                    id\n                    value\n                    sortOrder\n                }\n            }\n            owningMergeSet {\n                id\n            }\n            mergeSet {\n                id\n            }\n        }\n    }\n}"}

Share Tags

Receive your tags

Execute the following command for the party who owns the tag

curl --location 'https://api.ecoroute.io/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <YOUR_API_TOKEN>' \
--data-raw '{
    "query":"query queryTag(first: Int!, offset: Int!) {\n    queryTag(first: $first, offset: $offset) {\n        id\n        name\n        users {\n            id\n        }\n        searches {\n            id\n        }\n        searchesAggregate {\n            count\n        }\n    }\n}",
    "variables":{}
}'

Get your user

Execute the following command once for the party who wants to collaborate and once for the party who owns the tag

$ curl --location 'https://api.ecoroute.io/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <YOUR_API_TOKEN>' \
--data-raw '{
    "query":"query queryUser(first: Int!, offset: Int!) {\n    queryUser(first: $first, offset: $offset) {\n        id\n        email\n        tags {\n            id\n            name\n        }\n    }\n}",
    "variables": {}
}'

Add additional user to tag

Execute the following command for the party who owns the tag

curl --location 'https://api.ecoroute.io/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <YOUR_API_TOKEN>' \
--data '{
    "query":"mutation($input: UpdateTagInput!){\n  updateTag(input: $input){\n    tag {\n      id\n      name\n      users {\n        id\n      }\n    }\n    numUids\n  }\n}",
    "variables":{
        "input":{
            "filter":{
                "id":["<TAG_ID>"]
            },
            "set":{
                "users":[
                    {
                        "id":"<USER_ID_OWNER>"
                    },
                    {
                        "id":"<USER_ID_COLLABORATOR>"
                    }
                ]
            }
        }
    }
}'