API Reference

Authentication with Routy API

This page will help you get started with Routy API.

Introduction

Welcome to the Routy Guide! This document will provide you with a comprehensive overview of bearer token authentication and how to authenticate and use it in your API requests. Bearer token authentication is a widely adopted method for securing API endpoints and ensuring authorized access to protected resources.

Table of Contents

  1. What is a Bearer Token?
  2. Authenticating with Bearer Token
    1. Obtaining a Bearer Token
    2. Sending a Bearer Token
    3. Token Expiration and Refreshing
  3. Using Bearer Token in API Requests
  4. Common Errors and Troubleshooting

What is a Bearer Token?

A bearer token is a type of access token used to authenticate API requests. It is a string that grants access to protected resources on behalf of the user or client making the request. Bearer tokens are typically used in token-based authentication schemes, where the token is sent as an HTTP header.

Bearer tokens are called "bearer" because the token itself is sufficient to prove the bearer's identity and permissions. When using a bearer token, the server does not need to maintain any session state or store the token itself.

Authenticating with Bearer Token

2.1 Obtaining a Bearer Token

To obtain a bearer token for authentication, you typically need to follow these steps:

Register your application or user account with the API service provider.
Obtain the necessary credentials (client ID, client secret, username, password, etc.) from the provider.
Use the provided credentials to make an authentication request to the designated authentication endpoint of the API service.
If the authentication is successful, the server will issue a bearer token as a response. This token will be used for subsequent API requests.
It's important to note that the exact steps and requirements for obtaining a bearer token may vary depending on the API service you are using. Refer to the API documentation or contact the service provider for specific instructions.

2.2 Sending a Bearer Token

Once you have obtained a bearer token, you need to include it in your API requests for authentication. Bearer tokens are typically sent in the Authorization header of the HTTP request. The header format is as follows:

Authorization: Bearer <your-bearer-token>

Replace _<your-bearer-token>_ with the actual bearer token value you obtained during authentication.

2.3 Token Expiration and Refreshing

Bearer tokens often have an expiration time to enhance security. When a token expires, you will no longer be able to use it for authentication. To continue accessing the API, you may need to refresh your token.

To refresh a bearer token, you typically need to make a refresh token request to the API service's designated endpoint. This request usually includes the expired bearer token and, if applicable, a refresh token. The server will then respond with a new bearer token, which you can use for further API requests.

Again, the specific method and endpoint for refreshing bearer tokens may vary across different API services. Consult the API documentation or contact the service provider for detailed instructions.

Using Bearer Token in API Requests

To use a bearer token in your API requests, follow these steps:

  1. Include the bearer token in the Authorization header of your HTTP request as shown below:
Authorization: Bearer <your-bearer-token>
  1. Send the request to the desired API endpoint along with any required parameters or payload.
  2. The server will authenticate the request by verifying the bearer token. If the token is valid and has the necessary permissions, the server will process the request and return the
$http.post('/someUrl', data).success(successCallback);

alert('test');

Try dragging a block from the right to see how easy it is to add more content!