Choose language

Secure and seamless data transfers for emergency child welfare services

Flyt Barnevernvakt - External API

Gain access to employees, teams, client groups and person cases through a modern REST API.

Explore the technical documentation
n ung gutt med trist uttrykk lener seg mot en rusten stolpe utendørs. Bildet illustrerer sårbare barns behov for støtte fra barnevernsvakten, som tilbyr akuttberedskap for barn og familier i krise. n ung gutt med trist uttrykk lener seg mot en rusten stolpe utendørs. Bildet illustrerer sårbare barns behov for støtte fra barnevernsvakten, som tilbyr akuttberedskap for barn og familier i krise.
En illustrasjon som viser en mappe med ulike komponenter som deles ulike steder

Innovation begins with a simple call

The Flyt Barnevernvakt External API gives your systems programmatic access to Flyt Barnevernvakt data for your own organisation. Integrations replace manual exports and double registration, without changes to the source code. It is a REST API over HTTPS, with JSON requests and responses.

The possibilities with the API

The API allows authorized systems to:

Work with Employee Data

  • Search and fetch employees in your organisation
  • Create and update employee records
  • Activate and deactivate employees

Manage Teams

  • Fetch teams and their members
  • Create and update teams
  • Activate and deactivate teams

Manage Client Groups

  • Retrieve client groups and their composition
  • Create and update client groups
  • Activate and deactivate client groups

Work with Person Cases

  • Search and fetch person cases
  • Create and update case information
  • Follow case status across systems

Getting started

Three things must be in place before your first call: a Visma Connect tenant for your organisation, an application in that tenant, and the application's credentials.

  • Ask Visma Flyt for access. Send us the e-mail address of the person who will be your Integration Administrator. We create a Visma Connect tenant for your organisation and give that person the Integration Administrator role.
  • Create an application in the Developer Portal. The Integration Administrator opens your organisation's tenant, creates a client application, adds the API named flyt-barnevernsvakt-external-api-staging and selects the scopes the integration needs. Some scopes are granted at once, others after approval by Visma Flyt.
  • Collect three values: the application's client_id and client_secret, and your organisation's tenant_id. Keep the secret in a secret store, never in source code. Visma Flyt never sees it.

 

Your first call

curl -X POST "https://connect.identity.stagaws.visma.com/connect/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET" \
  -d "tenant_id=YOUR_TENANT_ID" \
  -d "scope=flyt-barnevernsvakt-external-api-staging:employees:read"

curl -X POST "{base-url}/api/v1/employees/search" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "limit": 10 }'
Create developer account

Framework and Guidelines

Security

We take information security seriously. Key elements of our security model include:

  • Authentication: OAuth 2.0 client credentials flow through Visma Connect.
  • Tenant-scoped tokens: Every token is issued for one tenant and limits each request to that organisation's data.
  • Scopes: Least-privilege access, following the pattern api:resource:read or write.
  • Transport: HTTPS only.
  • Separate environments: Staging and production have separate credentials, tokens and data.
Scope Grants
flyt-barnevernsvakt-external-api-staging:cases:read Read person cases
flyt-barnevernsvakt-external-api-staging:cases:write Create and update person cases
flyt-barnevernsvakt-external-api-staging:employees:read Read employees
flyt-barnevernsvakt-external-api-staging:employees:write Create and update employees
flyt-barnevernsvakt-external-api-staging:teams:read Read teams
flyt-barnevernsvakt-external-api-staging:teams:write Create and update teams
flyt-barnevernsvakt-external-api-staging:groups:read Read client groups
flyt-barnevernsvakt-external-api-staging:groups:write Create and update client groups

Errors

  • Errors are returned as RFC 9457 problem details. Every error response carries a traceId. Quote it when you contact support.

Support

  • Contact Visma Flyt support. Include the traceId from the error response and the environment you called.
  • Sign-in and activation problems in Visma Connect are handled through the help links in the Developer Portal.