SuperOffice Developer Portal

https://docs.superoffice.com/en/developer-portal
Admin
The SuperOffice Developer Portal is a platform for managing online integrations and applications,...
Tokens:30,096
Snippets:557
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Tenant Status API Request Example

Source: https://docs.superoffice.com/en/developer-portal/best-practices/tenant-status/check-status.html

An example of a GET request to the Tenant Status API for a specific tenant. Ensure you use the correct environment and context identifier.

```http
GET https://online.superoffice.com/api/state/Cust12345
```

--------------------------------

### Local Configuration File Example

Source: https://docs.superoffice.com/en/developer-portal/getting-started/quickstart.html

This is an example of the local file that stores your application's configuration details, including client ID, secret, and certificate information.

```text
App Name: My Awesome Demo App
Client ID: 1234567890abcdef1234567890abcdef
Client Secret: 1234567890abcdef1234567890abcdef
Certificate: 
<RSAKeyValue>
  Remainder removed for brevity
</RSAKeyValue>


```

--------------------------------

### SuperOffice Environment Base URLs

Source: https://docs.superoffice.com/en/developer-portal/getting-started/app-envir.html

Base URLs vary by environment. Use these examples for Development, Stage, and Production tenants.

```text
Development: https://sod.superoffice.com/Cust12345
Stage: https://qaonline.superoffice.com/Cust12345
Production: https://online.superoffice.com/Cust12345
```

--------------------------------

### SOAP API Call Example

Source: https://docs.superoffice.com/en/developer-portal/getting-started/app-envir.html

Example of a SOAP API call to retrieve a company by ID in the development environment, including the SOAP Action.

```text
https://sod.superoffice.com/Cust12345/remote/services87/contact.svc (SOAP Action: GetContactEntity)
```

--------------------------------

### REST API Call Example

Source: https://docs.superoffice.com/en/developer-portal/getting-started/app-envir.html

Example of a REST API call to retrieve a company by ID in the development environment.

```http
https://sod.superoffice.com/Cust12345/api/v1/contact/3/
```

--------------------------------

### Upgrade Payload Example

Source: https://docs.superoffice.com/en/developer-portal/best-practices/tenant-status/get-notifications.html

This JSON payload represents an 'Upgrade' event for a tenant, containing context identifier, version information, and a token.

```json
{
  "ChangeType": 0,
  "ContextIdentifier": "Cust12345",
  "VersionName": "Release 8.4 R08",
  "FileVersion": "8.4.12.1234",
  "Token": "eyJ234ASD...1234#"
}
```

--------------------------------

### Tenant Status API Response Example

Source: https://docs.superoffice.com/en/developer-portal/best-practices/tenant-status/check-status.html

This is a sample JSON response from the Tenant Status API. It includes the tenant's context identifier, endpoint, operational state, and validity period for the status information.

```json
{
    "ContextIdentifier": "Cust12345",
    "Endpoint": "https://online2.superoffice.com/Cust12345",
    "State": "Running",
    "IsRunning": true,
    "ValidUntil": "2026-02-23T09:52:01.9342965Z",
    "Api": "https://online2.superoffice.com/Cust12345/api",
    "Version": "Release_11.10_2026.02.24-02"
}
```

--------------------------------

### SOAP Request with System User Ticket

Source: https://docs.superoffice.com/en/developer-portal/getting-started/user-contexts.html

Example of a SOAP request using a system-user ticket as credentials in the SOAP header. This is used for non-interactive background tasks.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope namespaces left out for brevity>
  <Contact:ApplicationToken>1234567-1234-9876</Contact:ApplicationToken>
  <Contact:Credentials>
    <Contact:Ticket>7T:1234abcxyzExample==</Contact:Ticket>
  </Contact:Credentials>
 <SOAP-ENV:Body>
   <Contact:GetContactEntity>
    <Contact:ContactEntityId xsi:type="xsd:int">0</Contact:ContactEntityId>
   </Contact:GetContactEntity>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

```

--------------------------------

### Search Query for Merged Companies

Source: https://docs.superoffice.com/en/developer-portal/best-practices/index.html

This example demonstrates a search query to identify companies that have been merged into another, specifically targeting records where the source company was deleted. It filters based on merge operation details and registration time.

```URL
.../api/v1/archive/dynamic?$select=mergemovelog.operation, mergemovelog.tableNumber, mergemovelog.sourceRecord&$filter=movemergelog.registered afterTime <LastSyncTime>
```

--------------------------------

### Making a GET Request to Retrieve a Contact

Source: https://docs.superoffice.com/en/developer-portal/getting-started/quickstart.html

Use this snippet to fetch contact details by ID from SuperOffice Web Services. Ensure your Authorization header is correctly formatted with your access token and that you are using the correct subdomain and tenant ID.

```http
GET https://sod2.superoffice.com/Cust12345/api/v1/contact/3 HTTP/1.1
Authorization: Bearer 8A:Cust12345.AQeN6...removed for brevity
Accept: application/json


```

--------------------------------

### Use Default Endpoint for Entity Creation (REST API)

Source: https://docs.superoffice.com/en/developer-portal/best-practices/index.html

Use the /api/v1/{Entity}/default endpoint to create entities. This ensures the returned entity contains all preference-derived and default data structures.

```csharp
PersonEntity person = GetRequest("/api/v1/Person/default\u2091");
person.FirstName = "Jack";
person.LastName = "Black";
person.Contact = new Contact()
{
  ContactId = 1234; // where 1234 is a real contact ID
};

PostRequest(person, "/api/v1/Agent/Person");
...
```

--------------------------------

### Move Endpoint Payload Example

Source: https://docs.superoffice.com/en/developer-portal/best-practices/tenant-status/get-notifications.html

This JSON payload represents a 'Move endpoint' event for a tenant, including the public endpoint URL.

```json
{
  "ChangeType":5,
  "ContextIdentifier":"Cust12345",
  "VersionName":"Release_10.3.8_2024.08.30-01",
  "FileVersion":"10.3.8.2024",
  "Token":"eyJ....",
  "PublicEndpoint":"sod3.superoffice.com"
}
```

--------------------------------

### REST Request with System User Ticket

Source: https://docs.superoffice.com/en/developer-portal/getting-started/user-contexts.html

Example of a REST request where the system-user ticket is included in the Authorization header as an SOTICKET. This is for background service interactions.

```http
Authorization: SOTicket 7T:1234abcxyzExample==
SO-AppToken: Application_Token_Value

```

--------------------------------

### API Controller and JWT Validation

Source: https://docs.superoffice.com/en/developer-portal/best-practices/tenant-status/get-notifications.html

An API controller to receive and process tenant status change notifications, including JWT validation using SuperIdTokenHandler. Ensure the SuperOffice.Crm.Online.Core NuGet package is installed.

```csharp
public class NotifyCustomerStateChangeController : ApiController 
{
  public void Post([FromBody]NotificationMessage message) 
  {
    try
    {
      // SuperIdTokenHandler is available in NuGet package: SuperOffice.Crm.Online.Core
      SuperIdToken validated = ValidateToken(message.Token);
      // process accordingly...
    }
    catch (Exception ex)
    {
      // handle invalid token...
      throw;
    }
  }
  public static SuperIdToken ValidateToken(string token)
  {
    var path = System.Web.Hosting.HostingEnvironment.MapPath("~/App_Data/") + "SOD_SuperOfficeFederatedLogin.crt";
    var tokenHandler = new SuperIdTokenHandler();
    tokenHandler.JwtIssuerSigningCertificate = new X509Certificate2(path);
    tokenHandler.CertificateValidator = X509CertificateValidator.ChainTrust;
    tokenHandler.ValidIssuer = "https://sod.superoffice.com";

    return tokenHandler.ValidateToken(token, TokenType.Jwt);
  }
}
```

--------------------------------

### SOAP API Interaction with Access Token

Source: https://docs.superoffice.com/en/developer-portal/getting-started/user-contexts.html

Illustrates how to include the access token in the SOAP header for SOAP API requests.

```APIDOC
## SOAP API Request Header

### Description
When making SOAP API calls, the `access_token` is placed within the `Contact:Credentials` and `Contact:Ticket` elements in the SOAP header.

### Request Example
```xml
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <Contact:ApplicationToken xmlns:Contact="http://www.superoffice.com/crm/ws/">1234567-1234-9876</Contact:ApplicationToken>
    <Contact:Credentials xmlns:Contact="http://www.superoffice.com/crm/ws/">
      <Contact:Ticket>8A:Cust12345.abcxyzExample==</Contact:Ticket>
    </Contact:Credentials>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <Contact:GetContactEntity xmlns:Contact="http://www.superoffice.com/crm/ws/">
      <Contact:ContactEntityId xsi:type="xsd:int" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">0</Contact:ContactEntityId>
    </Contact:GetContactEntity>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
```
```

--------------------------------

### Tenant Status API Endpoint Structure

Source: https://docs.superoffice.com/en/developer-portal/best-practices/tenant-status/check-status.html

This shows the general structure of the GET request to the Tenant Status API. Replace ENVIR with your environment (sod, qaonline, or online) and CONTEXTID with your customer identifier.

```http
GET https://ENVIR.superoffice.com/api/state/CONTEXTID
```

--------------------------------

### Get Next Primary Key for 'person' Table

Source: https://docs.superoffice.com/en/developer-portal/best-practices/index.html

This snippet shows how to query the sequence table for the next primary key of the 'person' table. This is part of an estimation strategy to avoid full COUNT queries.

```HTTP
.../api/v1/archive/dynamic?$select=sequence.next_id&$filter=sequence.tablename = 'person'
```
Tokens:
Raw