{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/api/getting-started/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Intro

\n

Welcome to the Musement partner API documentation!

\n

This documentation is for partners who want to set up an API integration to sell activities from the Musement catalog.

\n

We are always looking for new partners to work with and have designed our system to meet multiple needs. Whether you're looking for a fully featured tours and activities booking application or a simple catalog browser, this resource contains all the information you need to get started.

\n

It includes an API reference and multiple examples for testing.

\n

Enjoy!

\n

Types of integrations

\n

Musement partners can choose between two types of API integrations: merchant or affiliate.

\n

Both types of integrations can use the Musement API to retrieve activity details, look up availability, create carts, place orders, check booking statuses and use post-booking functionalities. The key difference between the two options lies in payment.

\n

Merchant

\n

Merchant partners integrate with the entire Musement API to sell our catalog directly on their own platforms. For payment at the end of the booking flow, partners act as merchants of record and use the so-called no-payment flow. Access to this flow requires special authorization. To get set up, contact business-support@musement.com.

\n

As merchant of record, partners are expected to calculate and apply country-based taxes, take care of all monetary transactions with their customers, provide customer support, process cancellations/refunds and manage communication between suppliers and customers.

\n

Affiliate

\n

Affiliate partners do not manage payments: they use the so-called payment flow to connect with the Musement payment gateway Stripe. In this case Musement acts as the merchant of record.

\n

Affiliates can opt for a full or partial API integration. In a full integration, the whole user experience takes place on the affiliate’s platform, including payments to Musement via API. In a partial API integration, affiliates will integrate APIs related to searching the catalog only. After picking the activity, users will be redirected to the Musement platform for payment.

\n

Getting access to the API

\n

Access to the Musement API, even for simple testing, requires going through a few official procedures.

\n

1. Sign a contract

\n

Start by contacting our Strategic partnerships team at business@musement.com to begin negotiating a contract.

\n

2. Get sandbox environment access

\n

When your contract is finally signed, our API distribution team will provide your own sandbox authentication credentials and application value.

\n

3. Test in sandbox environment

\n

Once you have both your authentication credentials and application value, you can begin exploring our sandbox environment and testing your integration.

\n

4. Request production environment access

\n

When your testing is complete, contact our Strategic partnerships and API distribution teams to request access to our production environment.

\n

5. Complete the go-live checklist

\n

Before you receive access to our production environment, you will be asked to complete a checklist of requirements and recommendations, based on our quality checklist.

\n

6. Organize a demo

\n

Organize a demonstration of your integration with our Strategic partnerships and API distribution teams.

\n

7. Receive production environment access

\n

If your checklist and demo are accepted, you will receive production credentials and an application value from our API distribution team.

","headings":[{"value":"Intro","depth":1},{"value":"Types of integrations","depth":2},{"value":"Merchant","depth":3},{"value":"Affiliate","depth":3},{"value":"Getting access to the API","depth":2},{"value":"1. Sign a contract","depth":3},{"value":"2. Get sandbox environment access","depth":3},{"value":"3. Test in sandbox environment","depth":3},{"value":"4. Request production environment access","depth":3},{"value":"5. Complete the go-live checklist","depth":3},{"value":"6. Organize a demo","depth":3},{"value":"7. Receive production environment access","depth":3}]},"contentItem":{"data":{"lastModified":"2025-12-18T16:31:42.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"22e7c6d6-6c32-5e0e-94d5-f3ecf5d92a3e__redocly content/api/getting-started/","seo":{"title":"Intro","description":"Learn how to get started as a partner, selling activities from the Musement API catalog.","image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"api/getting-started/index.md","pageBaseUrl":"/api/getting-started/index","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Intro","id":"intro"},{"depth":2,"value":"Types of integrations","id":"types-of-integrations"},{"depth":3,"value":"Merchant","id":"merchant"},{"depth":3,"value":"Affiliate","id":"affiliate"},{"depth":2,"value":"Getting access to the API","id":"getting-access-to-the-api"},{"depth":3,"value":"1. Sign a contract","id":"1-sign-a-contract"},{"depth":3,"value":"2. Get sandbox environment access","id":"2-get-sandbox-environment-access"},{"depth":3,"value":"3. Test in sandbox environment","id":"3-test-in-sandbox-environment"},{"depth":3,"value":"4. Request production environment access","id":"4-request-production-environment-access"},{"depth":3,"value":"5. Complete the go-live checklist","id":"5-complete-the-go-live-checklist"},{"depth":3,"value":"6. Organize a demo","id":"6-organize-a-demo"},{"depth":3,"value":"7. Receive production environment access","id":"7-receive-production-environment-access"}]},"data":{"title":"","redirectFrom":["/guide","/guide/","/guide/overview/types-of-integration/","/guide/overview/who-is-the-api-for/","/suppliers/porta/","/api/partner/types-of-integrations/","/api/partner/"],"seo":{"description":"Learn how to get started as a partner, selling activities from the Musement API catalog."}},"catalogInfo":null,"link":"/api/getting-started/","sidebarName":"__alternative-sidebar__-data-24763-api-sidebars.yaml","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}