Newer
Older
---
sidebar_position: 1
title: Introduction
---
{/* Copyright 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH.
SPDX-License-Identifier: MIT */}
The Badge Programm checks openCode repositories and granting badges which are displayed in the
[openCode software catalog](https://opencode.de/en/software) and indicate
the status of the repository in terms of **security**, **maintenance**, and **reuse**.
You can interact with the Badge API by submitting a repository URL and receiving a badge based on the criteria that the repository meets. The API will
provide you a detailed explanation of the result too.
## Official Badges on openCode
Learn about the different types of badges that are available on openCode and what they mean in the [Official Badges 🛡️](/en/official-badges/active-maintained-badge) section.
Learn more about the ideas behind the Badge Programm, implemented checks, etc. in the [Concepts](/en/concepts) section.
You can try out the Badge API by using the [API Live Demo](/en/#api-small-demo).
### Use the API
To use the Badge RESTful API, you can submit a repository URL to the API and receive badges based on the criteria that the repository meets.
See all available endpoints and how to use them in the [API documentation](/en/api-docs).
You can host the Badge API yourself. We provide a [Helm chart to deploy the Badge API](https://gitlab.opencode.de/open-code/badgebackend/badge-api-helm-chart) on a Kubernetes cluster ⎈.
Alternatively, you can run the API locally as container or bare metal.
### Contribute to the Badge API
We are happy to receive contributions to the Badge API. You can find the source code on [openCode](https://gitlab.opencode.de/open-code/badgebackend/badge-api).
We welcome you to follow the [contribution guidelines](https://gitlab.opencode.de/open-code/badgebackend/badge-api/-/blob/main/CONTRIBUTING.md).
Do not hesitate to open an issue if you have any questions or need help.
## License
This project is licensed under the MIT License.