Happy International Programmers' Day ! To celebrate this fantastic day, we are taking our first exciting step to provide you with a developer-focused center of information and exchange within community. We are affectionately calling it the Developer Hub. Additionally, we are also proud to announce the launch of the API developers community group, so please invite your peers and API enthusiasts here. I want to start the trend of welcoming our newest members to the API developers group: @kevin.cho @ashish.banka @jwakefield @Joshua.Huilar @SR @GeorgeDuckett @AdamT Feel free to introduce yourselves and talk about some of the exciting projects that you are working on using Anaplan APIs. Cheers, Ashwin Krishnamurthy
... View more
Happy International Programmers’ Day! In celebration and gratitude for all that programmers do, Anaplan is shining the spotlight on developers by bringing our Developer Hub to life.
It is our goal to provide our customers with an open and extensible platform that seamlessly integrates with other systems. We want to boost awareness and adoption of our APIs, tools that will encourage harmonious coexistence with enterprise systems with Anaplan at the center as a planning source of truth. Consider this a step towards that goal and the start of something amazing. We cannot wait for what’s to come.
The Developer Hub is the first step in creating a developer-focused center of information and exchange. Designed with IT developers in mind, it provides an information architecture that enables developers to discover and learn about Anaplan APIs. The Developer Hub includes:
A curated compilation of all Community Content about Anaplan APIs.
An exclusive developer-only forum that fosters collaborative interaction and exchange amongst developers.
Access to developer-only events, webinars, and more.
Check out the Developer Hub today!
... View more
In this simple guide, we're going to help you make your first API call using an http client, and show you how easy it is to do. Once you understand how this works, you'll be able to quickly test API calls.
To keep things simple in this guide, we've used Postman as a client. But you can use the HTTP client or programming language of your choice to make these calls. The concepts across clients are more or less similar. To prepare for your API call you need to:
Download and install an http client of your choice (e.g. Postman, Insomnia, Paw etc.). If you want to start immediately, skip the next steps and move on to the 'Get Authenticated' section.
Anaplan APIs are RESTful. Take a look at this article on RESTful programming on REST to understand exactly what this means.
API responses are in a JSON encoded format. Review the 'Anaplan API Requirements' section in our official API Guide and Reference page to understand what JSON is.
⚠️ Disclaimer: Anaplan can't provide support for third-party tools such as Postman, Insomnia or Paw. Refer to the official documentation from their website links shared above or search online for a solution.
1. In this scenario, your first API call will be an authentication call. We will use basic authentication but we encourage you to understand some of the drawbacks of basic authentication.
2. When you open the Postman app, you will be asked to login. For the purpose of this guide, you don't need to create one. Select 'Skip and go to the app':
3. In your client, find an option that allows you to create a 'New request'. In Postman, select the 'New' button. You will be presented with a dialog box with a couple of options. Select 'HTTP Request'.
4. Copy and paste this endpoint: https://auth.anaplan.com/token/authenticate in the url input section (adjacent to the 'Send' button), and choose 'POST' as the method from the dropdown.
5. Under the Authorization tab, choose 'Basic' and enter your Anaplan username and password.
6. Press the 'Send' button.
7. Congratulations! You've successfully made your first API call. Right below the area where you entered your username and password, you should see a JSON output of the response from the server. Copy the 'tokenValue' from the response (the string of characters between the quotes), and save it in a handy location (such as a notepad). You'll be able to use it for other requests you make.
1. Try another request with the token that you've copied. To keep things simple, we'll use the Transactional APIs' List User Workspaces (https://anaplanbulkapi20.docs.apiary.io/#ListUserWorkspaces) to see what workspaces we have access to within the default tenant.
2. Similar to Step 2 in the "Get authenticated" section, create a new HTTP request in your client.
3. Copy and paste the endpoint: https://api.anaplan.com/2/0/workspaces?tenantDetails=true in the url input section, and choose 'GET' as the method under the method dropdown.
4. Go to the headers tab and add a new key called 'Authorization. Under 'Value', type 'AnaplanAuthToken' followed by a space and then paste the token you've copied (as shown below).
5. Select the 'Send' button.
6. If successful, you should receive a response that looks like this:
The best way to learn more about Anaplan APIs is to try out different requests. Start by visiting our official API Guide and Reference page and try some of the APIs listed there. For inspiration, check out the 'Design and develop' section.
... View more
Download libraries, SDKs, code snippets and other resources to help you streamline your development journey and improve your productivity.
Visit Github to download the Anaplan Java Client from Github which is under an Apache license.
Download Anaplan Connect v.2.0.0 Download Anaplan Connect v1.4.4
Refer to our official user guide under the Downloads section within Anapedia.
... View more
Find courses that help you to design and build integrations with Anaplan APIs and Anaplan Connect.
Introduction to Anaplan Connect
Anaplan Connect - Guidelines
Anaplan Connect – Data from a Flat File
Anaplan Connect – Data from a JDBC Database
The Anaplan Integration API
Data Integration – Part 1
Data Integration – Part 2
... View more
We have lots of specific, step-by-step guidance to help you plan and implement your project across CloudWorks, transactional, ALM APIs, and more. Use this section to understand what integration or API will best suit your use case.
Authentication is an important first step when it comes to building integrations. Use the API reference to get you started.
Basic authentication Follow a cURL example of how to execute a basic authentication.
CA Certificate based authentication Read this cURL example of how to execute a CA-certificate based authentication.
Refreshing Auth tokens Check out this cURL example of how to refresh an Auth token every 35 minutes.
Generating Authentication Strings for Using CA Certificates with API 2.0 Follow this Python-based example of how to execute a basic, as well as a CA-certificate based, authentication.
How to leverage sample codes to generate authentication strings from CA Certs? Get Windows, Python, and Java-based utilities to create authentications strings from CA certificates.
The CloudWorks API gives you an API-based access to integrations. For more information, visit the CloudWorks Apiary API reference.
CloudWorks – This is How We Use It, Part 3: The CloudWorks API Find out how to create a connection, an integration and run it using the CloudWorks API, Postman and AWS.
Transactional APIs allow you to access Anaplan data. Read a quick refresher on how to start transactional APIs, and visit the transactional API Apiary API reference.
Introduction Read the official Anaplan API introductory guide to transactional APIs.
Map dimensions to cell data export headers Learn how to retrieve metadata for dimensions on a view and cell data for a view.
Transactional APIs Use Cases Get a deep dive into 4 transactional API and Python use cases. Sample code is provided.
Transactional APIs Tutor Get a runnable tool that gives you easy access to authentication and transactional API calls.
If you're a workspace administrator, and your tenant has ALM enabled, you can run ALM processes with APIs. Get a quick refresher on ALM APIs and visit the ALM API reference .
... View more
Learn from other developers who may already have implemented the specific use case you're interested in. Browse through these scenarios to see if they answer your questions.
Building a Chat Bot interacting with Anaplan using AWS
Building a Chat Bot interacting with Anaplan using GCP
Using CloudWorks APIs with AWS Lambda
Analytics and reporting
Create Connection Between Anaplan and Power BI with API 2.0
Extracting data from Anaplan using Qlik
ETL, data virtualization and other tools
How to use Talend with CA Certificates and Transactional APIs
SQL Query Anaplan data using Transactional API via Data Virtualization through Denodo
Anaplan Connect 2.0 - Approaches to Anaplan integration using On-Prem integration platforms
... View more
Use this section to get a broad overview of Anaplan integrations and APIs so you can understand what's going to work best for you.
Find curated articles from the Anaplan Community and Anapedia that explain high-level concepts like authentication, on-premises connectivity, and more.
Or if you'd prefer to start building your API, head straight to the Design and develop or Scenarios pages.
We recommend that you start with Anaplan APIs in a Nutshell. This gives you an overview of all Anaplan's available APIs, along with links to technical and functional articles that help you to understand APIs.
How does Authentication with CA Certs work? explains the basic idea behind CA Certificates and how it works in practice.
Transactional APIs – Part 1: The Basics outlines what transactional APIs are and why you would want to use them.
You can also explore the official API Guide and Reference documentation, which outlines all of the technical information needed to consume Anaplan APIs.
Join our developer community
Ask questions in the API Developer user group, interact with other developers who are working Anaplan API related projects and keep abreast of the latest developments from the Anaplan Product team.
... View more