API Endpoints - VilnaCRM-Org/user-service GitHub Wiki

This document outlines the API endpoints in the User Service, as defined in the OpenAPI specification and implemented in the codebase.

OpenApi specification

You can go here, to get our OpenApi specification as a .yaml file, and then use Swagger Editor to browse it.

If you've set up User Service locally, you can check this URL to see the same OpenApi specification.

How to read the documentation

You will see a list of endpoints, and by clicking on them, you can see detailed information about each of them, such as description, available input, and possible responses.

Here is an example:

You can also send a request, by clicking the Try it out button in the upper right corner and providing required input.

Authorization

To get access to protected resources, click on the Authorize button in the upper right corner. After providing the required client credentials you'll be authorized.

Here is how the form looks:

GraphQL specification

You can go here, to get our GraphQL specification and then use GraphQL Playground to browse it.

If you've set up User Service locally, you can check this URL to see the same specification.

How to read the documentation

At the right side of the screen, you'll see a tab named Docs. There you'll find all the information about available Mutations and Queries.

Here is an example:

On the left side of the screen, you'll see a place for writing queries, from it you can send the requests.

Learn more about GraphQl Queries and Mutations.

Authorization

At the bottom part of the screen, you'll see an HTTP HEADERS tab. You can pass your Access Token via the Authorization header to get access to protected resources.

Here is an example:

Learn more about Developer Guide.