{"id":22826111,"url":"https://github.com/mbarre/ticketresto-nc-rest","last_synced_at":"2025-08-09T12:53:46.189Z","repository":{"id":28787348,"uuid":"116736402","full_name":"mbarre/ticketresto-nc-rest","owner":"mbarre","description":"Rest API to get Ticket Restaurant Nouvelle Calédonie account details.","archived":false,"fork":false,"pushed_at":"2023-03-06T07:59:44.000Z","size":226,"stargazers_count":3,"open_issues_count":6,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-23T08:17:00.234Z","etag":null,"topics":["rest-api","spring-boot"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mbarre.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-01-08T22:36:43.000Z","updated_at":"2024-07-04T13:46:59.000Z","dependencies_parsed_at":"2025-04-23T08:27:11.024Z","dependency_job_id":null,"html_url":"https://github.com/mbarre/ticketresto-nc-rest","commit_stats":null,"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"purl":"pkg:github/mbarre/ticketresto-nc-rest","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbarre%2Fticketresto-nc-rest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbarre%2Fticketresto-nc-rest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbarre%2Fticketresto-nc-rest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbarre%2Fticketresto-nc-rest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mbarre","download_url":"https://codeload.github.com/mbarre/ticketresto-nc-rest/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbarre%2Fticketresto-nc-rest/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269579577,"owners_count":24441367,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-09T02:00:10.424Z","response_time":111,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["rest-api","spring-boot"],"created_at":"2024-12-12T17:14:20.635Z","updated_at":"2025-08-09T12:53:46.125Z","avatar_url":"https://github.com/mbarre.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![CircleCI](https://circleci.com/gh/mbarre/ticketresto-nc-rest/tree/master.svg?style=svg)](https://circleci.com/gh/mbarre/ticketresto-nc-rest/tree/master)\n[![Join the chat at https://gitter.im/ticketresto-nc-rest/Lobby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ticketresto-nc-rest/Lobby)\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/7c95e64c1e730040ea4b)\n\n# ticketresto-nc-rest\n\nRest API to get Ticket Restaurant Nouvelle Calédonie account detail. It uses [Tickets Restaurant Java SDK](https://github.com/adriens/tickets-resto-nc-sdk) developed by [@adriens](https://www.linkedin.com/in/adrien-sales/).\n\nThe service is deployed on Heroku.\n\n## How to use the service on Heroku\n\n### Get your balance\n\n```\ncurl https://ticketresto-nc-rest.herokuapp.com/accounts/{identifier}/{password}/balance\n```\n\n### Get your account detail\n\n```\ncurl https://ticketresto-nc-rest.herokuapp.com/accounts/{identifier}/{password}/detail\n```\n\n### Get your transactions from a date\n\n```\ncurl https://ticketresto-nc-rest.herokuapp.com/accounts/{identifier}/{password}/transactions/{ddMMyyyy}\n```\n\n### Get all your transactions\n\n```\ncurl https://ticketresto-nc-rest.herokuapp.com/accounts/{identifier}/{password}/transactions\n```\n\n### Get all partners\n\n```\ncurl https://ticketresto-nc-rest.herokuapp.com/partners\n```\n\n... to get them as a ```pdf``` stream :\n\n```\ncurl https://ticketresto-nc-rest.herokuapp.com/partners/pdf\n```\n\n\n## Postman api documentation\n\nA [public postman documentation](https://documenter.getpostman.com/view/3489712/ticket-resto/7LuYy9B) is maintained : you'll find code samples so you'll be able to use the api from you favourite language (cURL, jQuery, Ruby, Python, Node, PHP, Go).\n\n## How to make it run on premise\n\n### Set the port\n\nDefault port number is *8090*, you can change it by editing the file *application.properties*\n```\nserver.port = 8090\n```\n\n### Build the project\n\n```\nmvn clean package\njava -jar target/ticketresto-nc-rest-{version}.jar\n```\n\nor even more straightforward start/stop :\n\nRun it live :\n\n```\nmvn spring-boot:run\n```\n\n\n\nAs a background process :\n\n```\nmvn spring-boot:start\n```\n\nand hence to stop it :\n\n```\nmvn spring-boot:stop\n```\n\n\n\nMore details on maven ```spring-boot``` goals [here](https://docs.spring.io/spring-boot/docs/current/maven-plugin/plugin-info.html)\n\n### Get your balance\n\n```\ncurl http://localhost:8090/accounts/{identifier}/{password}/balance\n```\n\n### Get your account detail\n\n```\ncurl http://localhost:8090/accounts/{identifier}/{password}/detail\n```\n\n### Get your transactions from a date\n\n```\ncurl https://localhost:8090/accounts/{identifier}/{password}/transactions/{ddMMyyyy}\n```\n\n### Get all your transactions\n\n```\ncurl https://localhost:8090/accounts/{identifier}/{password}/transactions\n```\n\n### Get all partners\n\n```\ncurl https://localhost:8090/partners\n```\n\n# End point output formats\n\nBy default, you get json. To get ```xml``` output, just add ```?mediaType=xml``` to the url and you're done. \n\n## How to use it with Docker\n\n### Build the Docker image with Maven\n\n```\nmvn install dockerfile:build    \n```\n\n### Run the Spring Boot App container \n\n```\ndocker container run -p 8090:8090 mbarre/ticketresto-nc-rest:latest\n```\n\n```\ndocker ps\nCONTAINER ID        IMAGE                               COMMAND                  CREATED             STATUS              PORTS                    NAMES\nc5f0eef3e3b7        mbarre/ticketresto-nc-rest:latest   \"java -Djava.secur...\"   15 seconds ago      Up 14 seconds       0.0.0.0:8090-\u003e8090/tcp   gallant_mayer\n```\n\n\n# API on RapidAPI\n\nAPI is published on [RapidAPI](https://rapidapi.com/adriens/api/ticketresto-nc).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmbarre%2Fticketresto-nc-rest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmbarre%2Fticketresto-nc-rest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmbarre%2Fticketresto-nc-rest/lists"}