NoodleSetup
API that allows configure programs for Noodle, (*1)
This PHP package is automatically generated by the Swagger Codegen project:, (*2)
Requirements
PHP 5.5 and later, (*3)
Installation & Usage
Composer
To install the bindings via Composer, add the following to composer.json
:, (*4)
{
"repositories": [
{
"type": "git",
"url": "https://github.com/softonic/noodle_setup_api_sdk.git"
}
],
"require": {
"softonic/noodle_setup_api_sdk": "*@dev"
}
}
Then run composer install
, (*5)
Manual Installation
Download the files and include autoload.php
:, (*6)
require_once('/path/to/NoodleSetup/vendor/autoload.php');
Tests
To run the unit tests:, (*7)
composer install
./vendor/bin/phpunit
Getting Started
Please follow the installation procedure and then run the following:, (*8)
createProgramPlatformLocale($id_program, $id_platform, $body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProgramsPlatformsLocalesApi->createProgramPlatformLocale: ', $e->getMessage(), PHP_EOL;
}
?>
Documentation for API Endpoints
All URIs are relative to https://noodle-setup-v1.sftapi.com, (*9)
Class |
Method |
HTTP request |
Description |
ProgramsPlatformsLocalesApi |
createProgramPlatformLocale |
POST /programs/{id_program}/platforms/{id_platform}/locales |
Creates a program configuration for a specific platform and locale |
ProgramsPlatformsLocalesApi |
deleteProgramPlatformLocale |
DELETE /programs/{id_program}/platforms/{id_platform}/locales/{id_locale} |
Deletes a program configuration for a specific platform and locale |
ProgramsPlatformsLocalesApi |
findProgramPlatformLocale |
GET /programs/{id_program}/platforms/{id_platform}/locales |
Finds a program configuration for a specific platform for all locales |
ProgramsPlatformsLocalesApi |
readProgramPlatformLocale |
GET /programs/{id_program}/platforms/{id_platform}/locales/{id_locale} |
Reads a program configuration for a specific platform and locale |
ProgramsPlatformsLocalesApi |
replaceProgramPlatformLocale |
PUT /programs/{id_program}/platforms/{id_platform}/locales/{id_locale} |
Replaces a program configuration for a specific platform and locale |
ProgramsPlatformsLocalesApi |
updateProgramPlatformLocale |
PATCH /programs/{id_program}/platforms/{id_platform}/locales/{id_locale} |
Updates a program configuration for a specific platform and locale |
SearchApi |
search |
POST /search |
Search a list of filters and returns the result |
Documentation For Models
Documentation For Authorization
noodle_setup
-
Type: OAuth
-
Flow: application
-
Authorization URL:
-
Scopes:
-
noodle_setup.find.program.platforms.locales: Finds a program configuration for a specific platform for all locales
-
noodle_setup.read.program.platforms.locales: Reads a program configuration for a specific platform and locale
-
noodle_setup.create.program.platforms.locales: Creates a program configuration for a specific platform and locale
-
noodle_setup.replace.program.platforms.locales: Replaces a program configuration for a specific platform and locale
-
noodle_setup.update.program.platforms.locales: Updates a program configuration for a specific platform and locale
-
noodle_setup.delete.program.platforms.locales: Deletes a program configuration for a specific platform and locale
oauth2
-
Type: OAuth
-
Flow: application
-
Authorization URL:
-
Scopes:
-
noodle_setup.find.programs.platforms.locales: Finds a program configuration for a specific platform for all locales
-
noodle_setup.read.programs.platforms.locales: Reads a program configuration for a specific platform and locale
-
noodle_setup.create.programs.platforms.locales: Creates a program configuration for a specific platform and local
-
noodle_setup.replace.programs.platforms.locales: Replaces a program configuration for a specific platform and local
-
noodle_setup.update.programs.platforms.locales: Updates a program configuration for a specific platform and local
-
noodle_setup.delete.programs.platforms.locales: Deletes a program configuration for a specific platform and local
-
noodle_setup.create.search: Search using a list of filters based in the identifiers.
Author
development@softonic.com, (*10)