Migrating from SOAP to REST

What’s changing

New Restful APIs are now available, and are taking the lead over historical SOAP APIs.

New features are continuously added to Octopia’s Seller Rest APIs,
enabling not only to manage your current activities on our platform, but also your business development with Octopia.

Starting from 2023 and into 2024, we encourage all our partners to start migrating their integrations from managing their e-commerce data through SOAP endpoints to managing all their e-commerce business with Octopia through REST APIs.

SOAP

  • · Format: XML
  • · Authentication: STS
  • · Usage: only POST queries
  • · Single endpoint
  • · Multiple methods
  • · Heavy body payload

REST

  • · Format: JSON
  • · Authentication: OAuth2 (OpenID Connect)
  • · Usage: standard HTTP queries
  • · Multiple APIs
  • · Multiple routes
  • · Simple query parameters
  • · New features

What’s in this guide

An overview

First some general information about the standards et best practices regarding REST API usage.

From basic information to practicalities for most API routes, let’s review the main API principles

Authentication changes

Authentication migrated from STS (Security Token Services) to OIDC (OpenID Connect)

Though similar, there are a few changes which will need a bit of attention. see Handling authentication with REST APIs

Your usual workflow

Finally, a general coverage of a basic business workflow spanning over

Scroll to Top