{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3cad51b4-c4bb-4d79-858d-d4823a9dcfaa","name":"Widgety API","description":"Welcome to the Widgety API!\n\nYou can use our API to get content from Widgety's content-sharing platform and seamlessly integrate it into your products.\n\n# Getting Access\n\nYou must have an application ID and application token to query the API. If you do not have an application ID and application token, you must contact us to assign you one. Please fill in the form [here](https://widgety.org/contact/), providing some information about your company as well as your contact details.\n\nOnce an app has been sent to you, you will be able to make requests based on the permissions assigned to your APP Key.\n\n# Using Postman\n\nThough you do not need Postman to be able to use the Widgety API, we believe it's a great tool to use to explore and make requests to the API.\n\nIf you wish to try this for yourself, simply click on the 'Run in Postman' button on the top right, which will prompt you to either sign up or add the 'Collection' to your Workspace. This will automatically import all the API requests and optional filters so you can quickly start making requests to our API.\n\nWhen you have imported the Collection, you will need to add in your API Key and Token into what Postman calls an 'Environment':\n\n<img src=\"https://content.pstmn.io/1eec22d9-1d74-460b-9d71-c8e31c7b029c/TXZKRTRpWndBby5naWY=\">\n\nOnce this is done, don't forget to switch to this new environment before making requests.\n\nTo make the live documentation easier to read we have unticked the `token` and `app_id` params for each of the request. Don't forget to tick these back on before running any of the requests.\n\n# Making API Requests\n\n**API BASE URL** `https://www.widgety.co.uk/api/`\n\nRequests to the API must be made over HTTPS. Any HTTP requests are met with a HTTP 302 to its HTTPS equivalent.\n\nRequest to the API can be returned in either JSON format or XML format. This is selected by appending the query string with the required format.\n\n**EXAMPLE JSON URL QUERY STRING** `https://www.widgety.co.uk/api/ships.json`\n\n**EXAMPLE XML URL QUERY STRING** `https://www.widgety.co.uk/api/ships.xml`\n\n# Permissions\n\n### Available Operators\n\nWith the exception of the Ports API, specific Operators are unlocked on each key for each API. The list was set up when the key was first created for you based on which Operators you wished to get access to. Should you wish to get new ones unlocked, please contact us via support.\n\n### Content levels\n\nSome of the requests in this documentation have multiple 'Example requests'. When available, you can switch between the different versions through the dropdown on the right of the 'Example request' heading.\n\nIf/when you have your own dedicated API key, which version you see when making the request will depend on the level of permission assigned to the key. So whilst multiple versions are visible in the documentation, your requests will only reflect one of these.\n\nWe only provide multiple versions here to reflect what is possible. If you don't think you have the correct permissions set, or wish to change them, please contact us via support.\n\n# Images Resizer\n\nYou can specify `cover_image_geometry` and `profile_image_geometry`for ships and operators.\n\nYou may also set this parameters for specific model only e.g. `entertainment_type_images_geometry`. This is useful for nested resources. If model specific param is not set general params (`cover_image_geometry` and `profile_image_geometry`) will be applied.\n\nFor Ships you may also set `images_geometry` which is general for all additional ship sections such as deckplans and dinning options. And you can use model specific params such as `uniq_feature_images_geometry` and `entertainment_type_images_geometry`\n\nShould you need the same image(s) in different sizes, you can pass arrays of geometry strings. In this case they will look like `images_geometry[]=1000x100#&images_geometry[]=200x200ne` and response will contain map with geometries and image links.\n\nSome examples of standard geometry strings:\n\n``` ruby\n'400x300'         # resize, maintain aspect ratio\n'400x300!'        # force resize, don't maintain aspect ratio\n'400x'            # resize width, maintain aspect ratio\n'x300'            # resize height, maintain aspect ratio\n'400x300<'        # resize only if the image is smaller than this\n'400x300>'        # resize only if the image is larger than this\n'50x50%'          # resize width and height to 50%\n'400x300^'        # resize width, height to minimum 400,300, maintain aspect ratio\n'2000@'           # resize so max area in pixels is 2000\n'400x300#'        # resize, crop if necessary to maintain aspect ratio (centre gravity)\n'400x300#ne'      # as above, north-east gravity\n'400x300se'       # crop, with south-east gravity\n'400x300+50+100'  # crop from the point 50,100 with width, height 400,300\n\n ```\n\nMore geometry string examples can be found [here](http://markevans.github.io/dragonfly/imagemagick#processors).\n\nEach applicable request will have a specific section containing the available geometry parameters, so you can see the full list of what's available.\n\n### Image URLs\n\nTo avoid creating unnecessary files on our Amazon Web Server, each image created using a specific set of geometry/compression will first be provided as a relative link. Once this link has been loaded once, the image will have been generated, and the request will return a proper AWS link from that point on.\n\nPlease note that you may find that some images will already been generated. This means that a previous user already requested the same geometry/compression for this image and that the file already exists on our Amazon Web Server.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"1661530","team":133488,"collectionId":"3cad51b4-c4bb-4d79-858d-d4823a9dcfaa","publishedId":"2s9YkgBjS7","public":true,"publicUrl":"https://developer.widgety.co.uk","privateUrl":"https://go.postman.co/documentation/1661530-3cad51b4-c4bb-4d79-858d-d4823a9dcfaa","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-03-13T10:44:37.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"My Widgety APP Key","id":"6d3b3de2-1ea4-4ce8-a809-8537dc286508","owner":"1661530","values":[{"key":"url","value":"https://www.widgety.co.uk","enabled":true},{"key":"app_id","value":"YOUR_APP_ID","enabled":true},{"key":"token","value":"YOUR_TOKEN","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/5ee84c999a43254896ac96d33c8745d29d7ba85bb654ad2a95e29fb7864be9b4","favicon":"https://res.cloudinary.com/postman/image/upload/v1710328941/team/gfphqzww1xbat2j84rth.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"My Widgety APP Key","value":"1661530-6d3b3de2-1ea4-4ce8-a809-8537dc286508"}],"canonicalUrl":"https://developer.widgety.co.uk/view/metadata/2s9YkgBjS7"}