Skip to content
Em Mov Coder Docs

Getting Started

This page explains the basic usage of the Em Mov Coder API.

Follow the steps below to start using the API quickly.

Account Registration

First, register an account at https://admin.coder.em-movimento.com/ . Enter the necessary information (email address, password) and complete your registration.

Project Creation and API Key Retrieval

After registering, log in to the management console and create a new project. When creating a project, enter the required information such as the project name and a basic description.

Once your project is created, generate an API key associated with that project. The API key is used to authenticate API requests and can be copied from the management console.

Keep this key secure and do not share it publicly. You will need to include the project ID and this key in the header when making API requests.

Setting Up the Environment and Authentication

Set up the necessary environment to use the API. This example uses Python, but the setup is similar in other programming languages.

When making requests to the API, you will need to provide authentication information using Basic Authentication. The following code snippet sets the ProjectID as the username and the API key as the password:

import requests
from requests.auth import HTTPBasicAuth


# Set up authentication details
project_id = 'YOUR_PROJECT_ID'  # Set your project ID here
api_key = 'YOUR_API_KEY'        # Set your API key here
api_url = 'https://api.coder.em-movimento.com/'


# Example of a request using Basic Authentication
response = requests.get(api_url, auth=HTTPBasicAuth(project_id, api_key))

Making Your First API Request

To test the basic functionality of the API, make your first GET request using Python with Basic Authentication. This method allows you to retrieve data from the API and check the content of the response.

Note: When using Basic Authentication, ensure that communication is done over HTTPS to maintain security. Do not hard-code your authentication details in the code, but manage them securely using environment variables.

import requests
from requests.auth in HTTPBasicAuth


# Set up authentication details
project_id = 'YOUR_PROJECT_ID'  # Enter your project ID here
api_key = 'YOUR_API_KEY'        # Enter your API key here
api_url = 'https://api.coder.em-movimento.com/requirements'


# Make an API request using Basic Authentication
response = requests.get(api_url, auth=HTTPBasicAuth(project_id, api_key))


# Check the response data
if response.status_code == 200:
    data = response.json()
    print('API request succeeded. Data:', data)
else:
    print('API request failed with status:', response.status_code)
    print('Error message:', response.text)

Exploring the API with Swagger UI

Em Mov Coder supports Swagger UI, allowing you to view API documentation and make real-time API requests through a web browser.

Access Swagger UI at the following URL:

https://api.coder.em-movimento.com/swagger-ui/index.html

Basic Authentication is also required when using Swagger UI. If the browser prompts for authentication details, use the ProjectID as the username and the API key as the password as used above.

Steps for Basic Authentication:

  1. Access the URL for Swagger UI.
  2. If the browser displays an authentication dialog, enter the ProjectID as the username and the API key as the password.
  3. After authentication, detailed documentation for each API endpoint is displayed, and you can send requests directly from Swagger UI.

This tool allows you to easily understand and test the functions of the API. You can also learn how to use the API by directly observing the structure of requests and responses.

Support and Resources

For more detailed specifications of the API, please refer to Swagger UI.

If you have further questions or need support, please contact us at info@em-movimento.com.