The Anaplan Financial Consolidation API requires user authentication to ensure the client and server communication is encrypted and secure, providing an additional layer of protection for your REST API interactions.
Note: To use the Financial Consolidation API you must send requests using a valid authentication token.
Environment security
We recommend you set up variables in your API development environment so that these can be passed through to the request, as each request is made.
There are four key environment variables that you can define to ensure the correct server, tenant, and version of the API, are addressed, together with the authentication token.
| Variable | Description | Example |
{HOSTNAME} | The name of the current REST API URL of your Financial Consolidation environment. The URL differs from your usual Anaplan portal URL. To ensure this works, use the example URL. Customers: If you use a development environment and want to use the REST API against it, you only need to use Anaplan internal users: If you're working in an internal DEV or DEMO environment, use on of the following based on your setup: | Customers: https://fluenceapi-prod.fluence.app |
{TENANT} | The name of the tenant of the tenant receiving requests and sending responses. The name of the tenant must be exactly as it displays in the Financial Consolidation user interface. If the tenant contains a space in the name, you must include the space; Likewise for an underscore. | CustomerTenant |
{API_TOKEN} | Create an API token in the Security module. Pass the token as an API key in the request header with the name X_API_TOKEN to enable the action. | 12345bc3-2929-599c-abc1-23f90aa94x3f |
{API_VERSION} | The current API Version is part of the request URL. | v2305.1 |
