LogoLogo
  • Technical Direction
  • Technical overview
    • Technical Implementation
    • API Design Guide
      • Data Definitions and Standards
      • Data Transfer Objects
      • Documentation
      • Environments
      • Error Handling
      • Example API Service
      • GraphQL Naming Conventions
      • Methods
      • Naming Conventions
      • Once Only Principle
      • Pagination
      • Resource Oriented Design
      • REST Request
      • REST Response
      • Security
      • Versioning
    • Ísland.is Public Web Data Flow
    • Code Reviews
    • Code Standards
    • Monorepo
    • Project Management
    • Teamwork
    • Architectural Decision Records
      • Use Markdown Architectural Decision Records
      • Use NX
      • Continuous Integration
      • CSS
      • Branching and Release Strategy
      • Error Tracking and Monitoring
      • What API Management Tool to Consider
      • Viskuausan Static Site Generator
      • Use OAuth 2.0 and OpenID Connect As Protocols for Authentication and Authorization
      • Unified Naming Strategy for Files and Directories
      • CMS
      • Open Source License
      • What Chart Library Should We Use Across Island.is?
      • What Feature Flag Service/application Should We Use at Island.is?
      • Logging, Monitoring and APM Platform
      • ADR Template
    • Log Management Policy
  • Products
    • Island.is Authentication Service
      • Terminology
      • Integration Options
      • Authentication Flows
      • Authorising API Endpoints
      • Session Lifecycle
      • Scopes and Tokens
      • Delegations
      • Configuration
      • Tools and Examples
      • Environments
      • Test IAS with Postman
      • Using the IAS admin portal
    • Notifications / Hnipp
      • New Notification Setup Guide
      • Notifications service workflow overview
      • Email notifications
    • Pósthólfið
      • Security Checklist
      • Introduction
      • Skjalatilkynning API
      • Skjalaveita API
      • Sequence Diagram
      • Interfaces
    • Straumurinn (X-Road)
      • Architecture Guidelines for Service Providers and Consumers
      • Setting up an X-Road Security Server
        • Network Configuration
      • X-Road - Uppfærsla á öryggisþjónum
      • Straumurinn - Notkun og umsýsla
      • X-Road Central - current version
  • Development
    • Getting Started
    • Generating a New Project
    • Definition of done
    • Devops
      • Continuous Delivery
      • Database
      • Dockerizing
      • Environment Setup
      • Logging
      • Metrics
      • NextJS Custom Server
      • Observability
      • Operations Base Principles
      • Security
      • Service Configuration
      • Support
    • AWS Secrets
    • Feature Flags
    • Documentation Contributions
    • Defining Monorepo Boundaries With Tags
    • OpenAPI
    • Code Generation
    • Workspace Settings (Deprecated)
    • External Contributions
  • REFERENCE
    • Problems
      • 400 Validation Failed
      • 400 Attempt Failed
      • 403 Bad Subject
      • 400 500 Template API Error
    • Glossary
  • Misc
    • Guide: Adding a Payment Step to an Application
    • Guide: Enable Organisations to Make Requests to an Application
    • README Template
Powered by GitBook
On this page
  • Development environment
  • Test environment (for providers of an API)
  • Sandbox environment (for consumers of an API)
  • Synthetic test data
  • Production test data
  • Production environment

Was this helpful?

  1. Technical overview
  2. API Design Guide

Environments

This document describes different environments and their purpose.

  • Development environment

  • Test environment (for providers of API)

  • Sandbox environment (for consumers of API)

  • Production environment

Development environment

The development environment used to develop APIs should contain set of processes and programming tools to develop functional APIs. The developed assets should be connected to revision control and build processes to create a functional API. The functional API can then be deployed to other test and production environments.

Test environment (for providers of an API)

The purpose of the test environment is to test new and changed code via either automated checks or non-automated techniques. This is to validate that the functionality of a provided API is correct before moving it to the production and sandbox environments.

This environment is not used by consumers of the API, only providers.

Sandbox environment (for consumers of an API)

The purpose of the sandbox environment is for consumers/subscribers of an API to test and develop applications using the API. Consumers can then test their application against supported versions of the API.

Data used by an API in a sandbox environment can be either production or synthetic test data.

Synthetic test data

Synthetic test data does not use any actual data from the production data store and sources. It is artificial data based on the data model for that database. Synthetic test data can be generated automatically by synthetic test data generation.

Production test data

Production test data is a copy of a production database that has been masked, or obfuscated, and subsetted to represent a portion of the database that is relevant to test the API.

Production environment

The live system hosting the API. Consumers of APIs use this environment to call APIs with live authentication and actual data.

PreviousDocumentationNextError Handling

Last updated 2 years ago

Was this helpful?