onecompiler-enterprise-apis.md

title	description	created	updated
OneCompiler Enterprise APIs	OneCompiler Enterprise APIs to integrate the Editor, APIs and Challenges into external applications	2022-11-01	2022-11-01

If you are looking for basic code execution APIs or Editor embedding check details here https://onecompiler.com/cheatsheets/onecompiler-apis

Pricing

Plan Name	E1	E2	E3	More/Custom
Price	$1,000 per month	$2,000 per month	$3,000 per month	Contact Us
Calls per month	10M	20M	30M	Unlimited*
Internet Permission	No	Yes	Yes	Yes
Isolated Runs	No	Yes	Yes	Yes
Priority Execution	Yes	Yes	Yes	Yes
Write Access	Yes	Yes	Yes	Yes
Max runtime	10s	20s	30s	Custom

Note: Get 2 months free when you purchase yearly plans!

User Creation

Following is the sample cURL request to create new user programatically

curl --location --request POST 'https://onecompiler.com/api/v1/createUser?access_token=your_access_token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Peter Griffin",
    "email": "[email protected]"
}'

On successful creation you get a response like below

{
    "_id": "3yhxfe7yu",
    "name": "Peter Griffin",
    "userId": "petergriffin",
    "email": "[email protected]",
    "picture": "https://static.onecompiler.com/images/blank-profile.png",
    "thumbnail": "https://static.onecompiler.com/images/blank-profile.png",
    "hidePicture": true,
    "status": "unlisted",
    "created": "2022-10-04T11:36:27.105Z",
    "api": {
        "createdBy": "your_api_id",
        "token": "zag5vxxxxxxxxxxxxxxxxxxxxxx555"
    }
}

Please capture the api.token data and store it. You can start using this to make API calls as the above created user.

Signing In a user programatically

To make a user login automatically for a session. Add the following query parameters to the eligible URL (ex. Embedded challenges)

1. apiKey
2. userApiToken

Example URL: https://onecompiler.com/embed/challenges/3w7dby3mt/beginners-coding-challenge?apiKey=your_api_id&userApiToken=user_specific_token

Creating challenges programatically

Following is the sample cURL shows creating challenges programatically

curl --location 'https://onecompiler.com/api/v1/challenges/create?access_token=your_token' \
--header 'Content-Type: application/json' \
--data '{
  "challenge": {
    "title": "Demo challenge created using API",
    "markdown": "Description of the challenge - created using API",
    "tags": [],
    "visibility": "unlisted",
    "properties": {
      "challengeType" : "code",
        "captureUser" : "yes",
        "captureTabChanges" : "yes",
        "startDate" : "2023-07-04T10:09:00.000Z",
        "endDate" : "2023-07-29T10:09:00.000Z",
        "enableFinish" : "yes",
        "enableTimeTracking" : "yes",
        "timeLimit" : 60,
        "disableCopyPaste" : true,
        "showInstructionsOnStart" : true,
        "hideScoreAfterProblemTitle" : true,
        "hideChallengeEndTime" : true,
        "showNextChallengeOnLastProblemOnly" : true,
        "showTabChangeWarning" : true,
        "showReportAfterFinish" : true,
        "closeAfterTabSwitches" : true,
        "maxTabSwitches" : 3
    }
  },
  "problems": [
    {
      "title": "Print Hello World",
      "markdown": "print the word, Hello World",
      "properties": {
        "problemType": "code",
        "score": 2,
        "options": {
          "code": {
            "supportedLanguages": null,
            "validations": [
              {
                "id": 1,
                "input": "NA",
                "output": "Hello World",
                "label": ""
              }
            ],
            "preloads" : "3ygcd9fxd, 3ygcdatnw, 3ygcdcmfr, 3ygcdense",
            "preloadsParsed" : {
                "java" : "3ygcd9fxd",
                "python" : "3ygcdatnw",
                "c" : "3ygcdcmfr",
                "cpp" : "3ygcdense"
            }
          }
        }
      }
    },
    {
      "title": "Even or Odd",
      "markdown": "Read the number as input and print even or odd",
      "properties": {
        "problemType": "code",
        "score": 2,
        "options": {
          "code": {
            "supportedLanguages": [
              "java",
              "python"
            ],
            "validations": [
              {
                "id": 1,
                "input": "6",
                "output": "even"
              },
              {
                "id": 2,
                "input": "5",
                "output": "odd"
              }
            ]
          }
        }
      }
    }
  ]
}'