API

Jasmin provides a Web REST API that allows you to access a subscription's data. This API covers all of the product's modules (Sales, Purchases, Taxes, etc.) and allows you to view data as well as create and update entities and transactions (documents), which makes it possible to create solutions that integrate Jasmin with any other system.

See more

The Jasmin Web API uses the OAuth 2.0 protocol to authorize access to Jasmin subscriptions. Developers of integration apps have an area where they can keep track of their integration applications.

For more info on OAuth 2.0, we recommend viewing the following articles:

• How does OAuth 2.0 authorization work?
• What authorization flows are supported by the Web API?

Application registration

The registration of applications is available in the App Store which is divided in three areas:

• App Store;
• Develop;
• My Subscription Apps.

Develop

This area is divided into two subareas: Publisher and Dashboard.

Publisher

In this subarea, the publishers list is associated to the user account, and it is allowed to add and remove publishers.

To add a new publisher, click on Create Publisher in the Publisher area and indicate the following data:

• Key: publisher's identifier;
• Name: publisher's public name;
• Description: publisher's description.

Dashboard

In this subarea, it is possible to view, edit, publish or remove applications, as well as create or remove subscriptions for testing.

1) Add new application

To add a new application, follow these steps:

1. Click on Create App in the Dashboard area;
2. Insert the following data about the application:
   - Product: product name;
   - Key: application's identifier;
   - Name: application's public name;
   - Description: application's description;
3. After confirming, you are redirected to the application setup page, where you will need to fill in all the necessary data.

This setup page is divided in six areas, and it is necessary to fill in the following information:

General:

You must fill in the following data:

• Product: product name;
• Version: application's version;
• Name: application's public name;
• Key: application's identifier;
• Publisher Key: publisher's identifier;
• Home Page: application's Web address (for informational purposes);
• Description: application's description.

Logo & Images:

In this area, you must specify the logo of the application for informational purposes.

Authorization

You must fill in the following data:

• OAuthFlow: authentication flow, that can be of 4 types - Implicit, Hybrid, Client Credentials and Authorization Code;
• Redirect URI: the page address that will be used in the authorization (see documentation on authorization).

When selecting the flow types Client Credentials or AuthorizationCode, you should generate a Client Secret in the available button, and it is necessary to save the application after changing the flow.  To get the token that authorizes the Jasmin API calls, it is necessary to have the Secret and the application key. It is not possible to recover this information, so you should save it safely. However, it is possible to generate a new Client Secret in the option Reset Client Secret.

Additional Settings

You must fill in the following data:

• App Store Preview Link: the app preview link from in the store. Can be used to subscribe the app without publishing it;
• Notifications Endpoint: the endpoint for sending notifications to the app;
• External Subscription Url: the external Url for redirecting to the app.

Distribution

After filling in all the necessary requirement, it is possible to submit the app for approval using the option Submit for approval. The state of approval of the app will be presented.

Delete App

You can remove the app from the App Directory using the option Delete App.

2) Edit an application's record

After creating an application, it can be edited, except for the following fields:

• Product;
• Name;
• Key.

You can also publish or unpublish applications, as well as request generating a new Client Secret (this option is only available for applications with the Client Credentials or AuthorizationCode types of authentication).

3) Publish/unpublish an application

By publishing an application, you are making it visible in the Jasmin App Store, and each user can subscribe it and use it in their subscriptions. On the other hand, when you unpublish an application, it is no longer visible in the App Store. However, the application can still be used from subscriptions that have previously associated it.

Note: These features are only available when editing an application and when listing applications, from the corresponding button.

4) Subscribe an app without publishing it

You can use or share the preview link to view how the app will look like on the store, as well as to subscribe the app for testing or to keep it private.

5) Create a new subscription for development purposes

For the development of integrated applications not to affect real customer accounts, we provide you with the ability to create a development subscription that can be used for this purpose.

This type of subscription is functionally identical and shares the same initial data as a DEMO subscription. This means that the subscription will have demo data, and that it will expire automatically after 30 days.

If a development subscription expires, the developer can always create a new one, bearing in mind that the data is also initialized again.

You can create up to three subscriptions.

6) Remove subscription

Removing a subscription will make it immediately unavailable from the Manager area.

My Subscription Apps

1) Associating an application to a subscription

By associating an application to a subscription you are allowing it to be used in that subscription.

To associate your app, follow these steps:

1. Select the app from the available app list;
2. Select the option Subscribe and the desired subscription;
3. Click Confirm.

2) Remove an application from a subscription

By removing an application from a subscription, it will no longer possible to use in that subscription.

See more