Step-by-step guide

...

Using the API

Prerequisites

Before you ask, API stands for Application Programming Interface, it describes how to use a system and what it can do. For us this is the place to start as it quickly shows you the power of the system! In this tutorial, we are going to use the API to access data about users (e.g. AEGEE members) and bodies (e.g. AEGEE Antennae) in the data base.

To use the API we are going to use a tool called Postman, it is a well-established chrome extension that makes using a REST API a breeze.

If you are using chrome you can find Postman here, otherwise you can find a standalone version here.

Steps to take

Run the OMS system as instructed in the installation guide
Fire up postman (open Apps of Google Chrome on the top left corner of the browser. If you have installed postman, it should show up here. Otherwise, see above)
Check to see if the system is running and ready to be used
1. Enter the URL to be `localhost`
2. Set the method to GET (left of the URL)
3. Hit Send!
Check if the response matches screenshot 1 on the left
1. Above the response are buttons: (pretty|raw|preview)
  1. These change the way the response is viewed
2. Press preview
3. It should look a little bit better now!
Log in as a User
1. Change the method to POST
2. Change the URL to `localhost/api/login`
3. Right below the the URL bar are buttons: (authorization|headers|body|pre-request scripts|tests)
  1. These are tabs to enter additional request settings.
  2. Note that the response has similar buttons, yet these are for the response!
4. Click the body button (of the request)
  1. Enter 2 new keys (screenshot 2; it might be necessary to select 'x-www-form-urlencoded')
    1. key='username', value='admin@aegee.org'
    2. key='password', value='1234'
5. Hit send!
6. Verify the response looks similar to response 1
See all the Users
1. Open a new tab within Postman
  1. I like to keep one tab open to quickly be able to login again and get a new token when needed
2. Set the method to GET
3. Set the URL to `localhost/api/users`
4. Open the request Header tab
  1. Enter a new key
    1. key='X-Auth-Token', value='enteranynumber'
5. Hit send!
  1. You should get a forbidden message
6. Enter the correct login token
  1. Go back to your login request
  2. Copy the value with the key "data"
    1. In the example response this is `da78dbb0-6ff4-11e7-bb7e-476b0d476473`
  3. Paste it in the value for the X-Auth-Token
7. Hit Send again!
8. Check if the response equals response 2
See your User
1. Keep the GET method
2. Keep the X-Auth-Token
3. Change the URL to 'localhost/api/users/1'
4. Hit Send!
5. Check if the response equals response 3
Create a Body
1. Set the method to POST
2. Set the URL back to 'localhost/api/bodies'
3. Hit Send!
4. Check the errors you got
5. Go to the Body tab of the request and enter the following keys
  1. key='type_id', value='1'
  2. key='address_id', value='1'
  3. key='name', value='yourfavouritelocal'
  4. key='email', value='yourfavouriteemailaddress'
6. Hit Send!
7. Check if your response is similar to response 4
Check all the Bodies
1. Try finding this out yourself!
Check the rest of the API. In the documentation you will find instructions on how to do what we just did already, and more. Mind: in the documentation it will say "http://oms.apiblueprint.org" instead of 'localhost'. You have to replace this, either by 'localhost' or by 'oms.aegee.org' to contact the right system.
1. The API documentation can be found here

Screenshot 1 - Postman

Image Added

Screenshot 2 - Postman//login

Image Added

Code Block

language	js
title	Response 1 - Login

{
    "success": true,
    "meta": null,
    "data": "da78dbb0-6ff4-11e7-bb7e-476b0d476473",
    "message": "User login token"
}

Code Block

language	js
title	Response 2 - GET Users
collapse	true

{
    "success": true,
    "meta": null,
    "data": [
        {
            "id": 2,
            "address_id": 2,
            "personal_email": "derk.snijders@aegee.org",
            "first_name": "Derk",
            "last_name": "Snijders",
            "date_of_birth": "1993-10-31 00:00:00",
            "gender": "male",
            "phone": null,
            "description": null,
            "remember_token": null,
            "is_superadmin": 1,
            "is_suspended": null,
            "suspended_reason": null,
            "seo_url": "i3anaan",
            "activated_at": "2017-07-18 10:13:06",
            "created_at": "2017-07-18 10:13:06",
            "updated_at": "2017-07-18 10:13:06",
            "internal_email": "derk.snijders@aegee.eu",
            "first_name_simple": "Derk",
            "last_name_simple": "Snijders"
        },
        {
            "id": 3,
            "address_id": 1,
            "personal_email": "nico.westerbeck@aegee.org",
            "first_name": "Nico",
            "last_name": "Westerbeck",
            "date_of_birth": "1985-04-16 00:00:00",
            "gender": "male",
            "phone": null,
            "description": null,
            "remember_token": null,
            "is_superadmin": 0,
            "is_suspended": null,
            "suspended_reason": null,
            "seo_url": "blacksph3re",
            "activated_at": "2017-07-18 10:13:06",
            "created_at": "2017-07-18 10:13:06",
            "updated_at": "2017-07-18 10:13:06",
            "internal_email": null,
            "first_name_simple": "Nico",
            "last_name_simple": "Westerbeck"
        },
        {
            "id": 4,
            "address_id": 1,
            "personal_email": "sergey.peshkov@aegee.org",
            "first_name": "Sergey",
            "last_name": "Peshkov",
            "date_of_birth": "1985-04-16 00:00:00",
            "gender": "male",
            "phone": null,
            "description": null,
            "remember_token": null,
            "is_superadmin": 0,
            "is_suspended": null,
            "suspended_reason": null,
            "seo_url": "sergey.peshkov",
            "activated_at": "2017-07-18 10:13:06",
            "created_at": "2017-07-18 10:13:06",
            "updated_at": "2017-07-18 10:13:06",
            "internal_email": null,
            "first_name_simple": "Sergey",
            "last_name_simple": "Peshkov"
        },
        {
            "id": 5,
            "address_id": 1,
            "personal_email": "fabrizio.bellicano@aegee.org",
            "first_name": "Grace",
            "last_name": "Hopper",
            "date_of_birth": "1985-04-16 00:00:00",
            "gender": "female",
            "phone": null,
            "description": null,
            "remember_token": null,
            "is_superadmin": 0,
            "is_suspended": null,
            "suspended_reason": null,
            "seo_url": "gracehopper",
            "activated_at": "2017-07-18 10:13:07",
            "created_at": "2017-07-18 10:13:07",
            "updated_at": "2017-07-18 10:13:07",
            "internal_email": null,
            "first_name_simple": "Grace",
            "last_name_simple": "Hopper"
        },
        {
            "id": 6,
            "address_id": 1,
            "personal_email": "headoffice@aegee.org",
            "first_name": "Big",
            "last_name": "Boobs",
            "date_of_birth": "1998-04-16 00:00:00",
            "gender": "female",
            "phone": null,
            "description": null,
            "remember_token": null,
            "is_superadmin": 0,
            "is_suspended": null,
            "suspended_reason": null,
            "seo_url": "boobies",
            "activated_at": "2017-07-18 10:13:07",
            "created_at": "2017-07-18 10:13:07",
            "updated_at": "2017-07-18 10:13:07",
            "internal_email": null,
            "first_name_simple": "Big",
            "last_name_simple": "Boobs"
        },
        {
            "id": 1,
            "address_id": 1,
            "personal_email": "admin@aegee.org",
            "first_name": "Super",
            "last_name": "Admin",
            "date_of_birth": "1985-04-16 00:00:00",
            "gender": "other",
            "phone": null,
            "description": null,
            "remember_token": "whFezyRDtQV1zRvgoh3rxbKarI39fDObmKiRmPDFDQwjfnhP1xZ9nXVkD8NE",
            "is_superadmin": 1,
            "is_suspended": null,
            "suspended_reason": null,
            "seo_url": "superadmin",
            "activated_at": "2017-07-18 10:13:06",
            "created_at": "2017-07-18 10:13:06",
            "updated_at": "2017-07-18 10:13:06",
            "internal_email": null,
            "first_name_simple": "Super",
            "last_name_simple": "Admin"
        }
    ],
    "message": null
}

Code Block

language	js
title	Response 3 - GET Users/1
collapse	true

{
    "success": true,
    "meta": null,
    "data": {
        "id": 1,
        "address_id": 1,
        "personal_email": "admin@aegee.org",
        "first_name": "Super",
        "last_name": "Admin",
        "date_of_birth": "1985-04-16 00:00:00",
        "gender": "other",
        "phone": null,
        "description": null,
        "remember_token": "whFezyRDtQV1zRvgoh3rxbKarI39fDObmKiRmPDFDQwjfnhP1xZ9nXVkD8NE",
        "is_superadmin": 1,
        "is_suspended": null,
        "suspended_reason": null,
        "seo_url": "superadmin",
        "activated_at": "2017-07-18 10:13:06",
        "created_at": "2017-07-18 10:13:06",
        "updated_at": "2017-07-18 10:13:06",
        "internal_email": null,
        "first_name_simple": "Super",
        "last_name_simple": "Admin",
        "address": {
            "id": 1,
            "country_id": 21,
            "street": "Notelaarsstraat 55",
            "zipcode": "1000",
            "city": "Brussels",
            "created_at": "2017-07-18 10:13:06",
            "updated_at": "2017-07-18 10:13:06"
        },
        "bodies": [
            {
                "id": 1,
                "type_id": 2,
                "address_id": 1,
                "name": "AEGEE-Europe",
                "email": "headoffice@aegee.org",
                "phone": null,
                "description": null,
                "legacy_key": "AEU",
                "created_at": "2017-07-18 10:13:06",
                "updated_at": "2017-07-18 10:13:06",
                "name_simple": "AEGEE-Europe",
                "pivot": {
                    "user_id": 1,
                    "body_id": 1
                }
            }
        ],
        "circles": [
            {
                "id": 4,
                "body_id": 4,
                "parent_id": 1,
                "name": "Lia & Derk",
                "description": "IT people in da house",
                "created_at": "2017-07-18 10:13:07",
                "updated_at": "2017-07-18 10:13:07",
                "name_simple": "Lia & Derk",
                "pivot": {
                    "user_id": 1,
                    "circle_id": 4
                }
            }
        ]
    },
    "message": null
}

Response 4

Jira Legacy

server	JIRA (oms-project.atlassian.net)
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	edf3f91b-210c-3cfc-933c-f8d8084c5f2c
key	CORE-112

Versions Compared

Old Version 1

New Version Current

Key

Step-by-step guide

Related articles

Using the API

Prerequisites

Steps to take

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Step-by-step guide

Related articles

Using the API

Prerequisites

Steps to take