Managing REST endpoints

The InCountry Data Residency for Salesforce package pre-defines the REST endpoints for data communication between Salesforce and the InCountry platform. You can manage these REST endpoints if needed and change them for some custom ones.

  1. From Setup, click Custom Code, then select Custom Metadata Types.

  2. On the Custom Metadata Types page, locate the InCountryRestApiEndpoint object and click Manage Records.

    Manage Records

  3. On the opened InCountryRestApiEndpoint page, locate the country whose REST API endpoint you want to modify.

    Locate Country

  4. For the required country, click Edit.

    Edit

  5. On the opened page, you can modify the following:

    1. Label - enter the label of the country in the ISO format (upper case).
    2. InCountryRestApiEndpoint Name - enter the label of the country in the ISO format (upper case).
    3. Country - select the country from the prompted variants.
    4. Endpoint - specify another InCountry REST API endpoint in the target country. Contact the InCountry team to get the actual endpoint address.
    5. Default - check the box to use the current InCountry REST API endpoint as default for all data requests.
    6. Token - enter the token name as 'Bearer (JWS)'.
    7. CertificateNameServerless - enter the name of the certificate for serverless functions. You need to enter the name of the certificate which was issued for serverless functions without the *.JKS file extension, so that only the certificate name remains. The pattern for this looks like '{your_company}_serverless'.
    8. CertificateNameApi - enter the certificate name for performing requests from the backend. This is applicable to the replication model. The name of such certificate is individual for each customer.
    9. CertificateNameRest - enter the certificate name for performing REST API requests from the frontend. Such requests are performed through the dedicated /sf endpoint of InCountry REST API and authorization of such requests is executed with a JWT token. This is applicable to the redaction model. The name of such certificate is individual for each customer.
    10. CertificateNameBatch - name of the certificate for batch data operations. You need to enter the name of the certificate which was issued for batch operations without the *.JKS file extension, so that only the certificate name remains. The pattern for this looks like '{your_company}_batch'.

  6. When complete, click Save.

note

Please avoid modifying these parameters if not needed.

To create a new InCountry REST endpoint:

  1. Initiate the management of records within the InCountryRestApiEndpoint object.

  2. Above the table with REST endpoints, locate the New button and click it.

    REST endpoint

  3. On the opened page, fill out details for the REST endpoint as described above for management of REST endpoints. To get the actual address of REST endpoint, please contact the InCountry team.

    REST endpoints

  4. When complete, click Save.

← Managing InCountry EndpointsManaging InCountry flags →