Services

A service is an entity representing a connection point that can be used to integrate your system with other components of the InCountry platform or SaaS services (like Salesforce).

You can manage services as follows:

1. Create new services
2. Renew existing services
3. Delete the no longer needed services

note

Please consider that you can create only one service of each type per one country. You cannot create multiple Salesforce, resident functions, or REST API services for the same country within the same environment.

Creating new services

The InCountry Portal does not create a default service together with the creation of a default environment. You can create a service of the four types, as follows:

1. Salesforce is used for the operation of the InCountry Data Residency for Salesforce package.
2. Resident Functions is used for the management and execution of resident functions on the target Point-of-Presence (PoP).
3. REST API is used for data communication with REST API (for server-to-server connection). For the details on how to use it, please check the REST API documentation.
4. Web Servicesis used for data communication through Border and redaction / unredaction of regulated data processed by Border.

Creating a new Salesforce service

1. Expand the environment and country in the left sidebar where you wish to create a new service, then click on the Services menu item.
2. Click Add service button.
3. On the Select service page, select the Salesforce service.
4. Click Next.
5. Enter the verification code.
6. Click Create.
7. On the page with the created Salesforce service, save the environment ID, Client ID, Client Secret, REST API address, and Subject Claim. To download a text file with all these credentials, click Download. To copy these credentials to the clipboard, click Copy to clipboard.
8. When complete, click Close.

tip

Use the received credentials to establish a connection to the InCountry platform in the InCountry Data Residency for Salesforce package and to configure endpoints. Please do not forget to save the subject claim as it is used as a unique identifier of the tenant on the InCountry platform.

Uploading the public certificate

note

Before uploading a public certificate to InCountry Portal, please configure OAuth2 authorization in Salesforce as described in our documentation.

Once you have created the Salesforce service and registered a self-signed certificate in Salesforce, you need to upload the public certificate in the CRT format to the InCountry Portal.

1. Open the environment and the country where the Salesforce service was created.
2. On the list of services, locate the service of the Salesforce type.
3. Click the Upload certificate icon.
4. On the Select certificate page, click Select certificate and select the public certificate you downloaded from Salesforce.
5. Click Next.
6. Enter the verification code and click Upload.

note

Salesforce generates a certificate for one year, after this period you need to re-generate the certificate and upload its new version on the InCountry Portal. Click the Replace Certificate icon and upload a new version of the certificate. The procedure is quite similar to certificate upload.

Creating a new Resident Functions service

1. Open the environment and the country where you want to create a new service.
2. Click Add service.
3. On the Select service page, select the Resident Functions service.
4. Click Next.
5. Enter the verification code.
6. Click Create.
7. On the page with the created service of the Resident Functions type, save the environment ID, Client ID, Client Secret, and REST API address. To download a text file with all these credentials, click Download. To copy these credentials to the clipboard, click Copy to clipboard.
8. When complete, click Close.

For the details on managing resident functions, please check our documentation.

A new service of the Resident Functions type will appear on the list with other services within the current environment. Having created such a service, you can proceed with the publication of resident functions.

Creating a new REST API service

info

This service type is used for server-to-server communication (backend requests only).

1. Open the environment and the country where you want to create a new service.
2. Click Add service.
3. On the Select service page, select the REST API service.
4. Click Next.
5. Add REST API service page will open. Here, you have the option to assign an Access Policy to this service or Enable the auth flow, which provides an additional authorization method for querying and managing regulated records from the application frontend. More details about this feature can be found on the Fine Grained Access page.
6. Click Create.
7. Enter the verification code.
8. Depending on whether you selected the Enable the auth flow checkbox or not, you will be presented with either one set of credentials or two sets. Make sure to save those credentials. To download a text file with all these credentials, click Download. To copy these credentials to the clipboard, click Copy to clipboard.
9. When complete, click Close.

A new REST API service will appear on the list with other services within the current environment.

Creating a new Web Services service

1. Open the environment and the country where you want to create a new service.
2. Click Add service.
3. On the Select service page, select the Web Services service.
4. Click Next.
5. Enter the verification code.
6. Click Create.
7. On the page with the created Web Services service, save the environment ID, Client ID, Client Secret, and Proxy address. To download a text file with all these credentials, click Download. To copy these credentials to the clipboard, click Copy to clipboard.
8. When complete, click Close.

A new Web Services service will appear on the list with other services within the current environment. You can proceed with defining the Border configuration.

Renewing the service

You can renew the Client ID and Client Secret that are used within a particular service. This may be required when you lose the client secret but do not want to create a new service.

1. Open the environment and the country where you want to renew the existing service.
2. On the list of services, locate the service you want to renew.
3. Click the Renew service icon.
4. Enter the verification code.
5. Confirm the operation by clicking Renew.
6. On the page with the renewed service, save the environment ID, Client ID, Client Secret, and REST API address. To download a text file with all these credentials, click Download. To copy these credentials to the clipboard, click Copy to clipboard.
7. When complete, click Close.

Deleting the service

If you no longer need some service, you can delete it. After the removal, the issued credentials for the service will be no longer valid, so you cannot use them for further data management on the InCountry platform.

1. Open the environment and the country where you want to delete the existing service.
2. On the list of services, locate the service you want to renew.
3. Click the Delete service icon.
4. On the Delete service page, enter the verification code.
5. Once entered, click Delete.