Skip to content

Quick Start Guide

Get Started

Our developer-friendly APIs are designed to be seamlessly integrated into your product. To ensure a smooth onboarding experience, we provide comprehensive API documentation, FAQs, a rich collection of code examples, SDKs, and developer support via Slack or e-mail.

How to onboard?

  • Visma Company: We offer self-sign-up for Visma email holders, where you can set up a project from the Development Portal as described in the Quick Start Guide below.

Quick Start Guide for Visma companies

Note

Self sign up and access to the portal requires a Visma e-mail. Contact us or write us on our Visma slack channel and we can provide you with a token, which you can use to access our API.

  1. Choose Your Environment and Access the Portal:
  2. Create a Project:
    • Sign up and create a project in your chosen environment
    • Use a clear project name (e.g., your product name)
    • Note: If you plan to go live, you'll eventually need to create a matching project in production
  3. Obtain Your API Token:
    • You'll be asked to create a token when you first create a project
    • Alternatively, go to the Tokens section in the Portal sidebar to generate tokens
    • For detailed authentication information, see the Authentication guide
    • Security: Never share your API tokens; treat them like passwords
  4. Optional: Add Team Members:
    • Manage project access by adding team members in the Users section
  5. Find Your API Endpoints:
    • See the Endpoints page for your API URLs
    • Staging endpoints: Use for all development work
    • Production endpoints: Use only for live customer data
  6. Explore SDKs and API Guides:
  7. Test Thoroughly in Staging:
    • Validate your integration fully in the staging environment
    • Use test data to ensure everything works as expected
    • Review API documentation for available endpoints and parameters
  8. Move to Production:
    • Once satisfied with staging tests, create a project in production
    • Use production endpoints and tokens for live workloads
    • Always test new features in staging first before rolling out to production

Need help? Find our contact information in the Support section.